jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #1764 from boydgreenfield/further_doc_fixes

Browse source 
Further doc fixes
This commit is contained in:
Andreas Rumpf 2014-12-22 18:51:07 +01:00
commit 8e09a82a17
5 changed files with 33 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

14
config/nimdoc.cfg
View file

@ -130,7 +130,7 @@ html {
-ms-text-size-adjust: 100%; } -ms-text-size-adjust: 100%; }
/* Where we want fancier font if available */ /* Where we want fancier font if available */
h1, h2, h3, h4, h5, h6, p.module-desc, blockquote p { h1, h2, h3, h4, h5, h6, p.module-desc, table.docinfo + blockquote p, table.docinfo blockquote p, h1 + blockquote p {
font-family: "Raleway", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif !important; } font-family: "Raleway", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif !important; }
h1.title { h1.title {
@ -523,9 +523,13 @@ abbr.initialism {
blockquote { blockquote {
padding: 0 0 0 15px; padding: 0 0 0 15px;
margin: 0 0 20px; margin: 0 0 20px;
border-left: 5px solid #c9c9c9; } border-left: 5px solid #EFEBE0; }
blockquote p { table.docinfo + blockquote, table.docinfo blockquote, h1 + blockquote {
border-left: 5px solid #c9c9c9;
}
table.docinfo + blockquote p, table.docinfo blockquote p, h1 + blockquote p {
margin-bottom: 0; margin-bottom: 0;
font-size: 15px; font-size: 15px;
font-weight: 200; font-weight: 200;
@ -605,6 +609,10 @@ table {
border-collapse: collapse; border-collapse: collapse;
border-spacing: 0; } border-spacing: 0; }
table th, table td {
padding: 0px 8px 0px;
}
.table { .table {
width: 100%; width: 100%;
margin-bottom: 20px; } margin-bottom: 20px; }

5
doc/basicopt.txt
View file

@ -1,5 +1,6 @@
Usage:: ::
nim command [options] [projectfile] [arguments]
nim command [options] [projectfile] [arguments]
Command: Command:
//compile, c compile project with default code generator (C) //compile, c compile project with default code generator (C)

4
doc/gc.txt
View file

@ -5,8 +5,12 @@ Nim's Garbage Collector
:Author: Andreas Rumpf :Author: Andreas Rumpf
:Version: |nimversion| :Version: |nimversion|
..
"The road to hell is paved with good intentions." "The road to hell is paved with good intentions."
Introduction Introduction
============ ============

4
doc/nimc.txt
View file

@ -30,8 +30,12 @@ Command line switches
--------------------- ---------------------
Basic command line switches are: Basic command line switches are:
Usage:
.. include:: basicopt.txt .. include:: basicopt.txt
----
Advanced command line switches are: Advanced command line switches are:
.. include:: advopt.txt .. include:: advopt.txt

16
tools/nimweb.nim
View file

@ -268,18 +268,18 @@ proc buildDoc(c: var TConfigData, destPath: string) =
commands = newSeq[string](len(c.doc) + len(c.srcdoc) + len(c.srcdoc2)) commands = newSeq[string](len(c.doc) + len(c.srcdoc) + len(c.srcdoc2))
i = 0 i = 0
for d in items(c.doc): for d in items(c.doc):
commands[i] = "nim rst2html $# --docSeeSrcUrl:$#/$#/$# -o:$# --index:on $#" % commands[i] = "nim rst2html $# --docSeeSrcUrl:$#/$# -o:$# --index:on $#" %
[c.nimArgs, c.gitRepo, c.gitCommit, splitFile(d).dir, [c.nimArgs, c.gitRepo, c.gitCommit,
destPath / changeFileExt(splitFile(d).name, "html"), d] destPath / changeFileExt(splitFile(d).name, "html"), d]
i.inc i.inc
for d in items(c.srcdoc): for d in items(c.srcdoc):
commands[i] = "nim doc $# --docSeeSrcUrl:$#/$#/$# -o:$# --index:on $#" % commands[i] = "nim doc $# --docSeeSrcUrl:$#/$# -o:$# --index:on $#" %
[c.nimArgs, c.gitRepo, c.gitCommit, splitFile(d).dir, [c.nimArgs, c.gitRepo, c.gitCommit,
destPath / changeFileExt(splitFile(d).name, "html"), d] destPath / changeFileExt(splitFile(d).name, "html"), d]
i.inc i.inc
for d in items(c.srcdoc2): for d in items(c.srcdoc2):
commands[i] = "nim doc2 $# --docSeeSrcUrl:$#/$#/$# -o:$# --index:on $#" % commands[i] = "nim doc2 $# --docSeeSrcUrl:$#/$# -o:$# --index:on $#" %
[c.nimArgs, c.gitRepo, c.gitCommit, splitFile(d).dir, [c.nimArgs, c.gitRepo, c.gitCommit,
destPath / changeFileExt(splitFile(d).name, "html"), d] destPath / changeFileExt(splitFile(d).name, "html"), d]
i.inc i.inc
@ -311,8 +311,8 @@ proc buildAddDoc(c: var TConfigData, destPath: string) =
# build additional documentation (without the index): # build additional documentation (without the index):
var commands = newSeq[string](c.webdoc.len) var commands = newSeq[string](c.webdoc.len)
for i, doc in pairs(c.webdoc): for i, doc in pairs(c.webdoc):
commands[i] = "nim doc $# --docSeeSrcUrl:$#/$#/$# -o:$# $#" % commands[i] = "nim doc $# --docSeeSrcUrl:$#/$# -o:$# $#" %
[c.nimArgs, c.gitRepo, c.gitCommit, splitFile(doc).dir, [c.nimArgs, c.gitRepo, c.gitCommit,
destPath / changeFileExt(splitFile(doc).name, "html"), doc] destPath / changeFileExt(splitFile(doc).name, "html"), doc]
mexec(commands, c.numProcessors) mexec(commands, c.numProcessors)