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

Adds docstring to rstgen.defaultConfig.

Browse source
This commit is contained in:
Grzegorz Adam Hankiewicz 2013-12-23 00:44:30 +01:00
commit f33f15afe8
1 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

13
lib/packages/docutils/rstgen.nim
View file

@ -688,7 +688,18 @@ proc formatNamedVars*(frmt: string, varnames: openarray[string],
proc defaultConfig*(): PStringTable = proc defaultConfig*(): PStringTable =
## creates a default configuration for HTML generation. ## Returns a default configuration for embedded HTML generation.
##
## The returned ``PStringTable`` contains the paramters used by the HTML
## engine to build the final output. For information on what these parameters
## are and their purpose, please look up the file ``config/nimdoc.cfg``
## bundled with the compiler.
##
## The only difference between the contents of that file and the values
## provided by this proc is the ``doc.file`` variable. The ``doc.file``
## variable of the configuration file contains HTML to build standalone
## pages, while this proc returns just the content for procs like
## ``rstToHtml`` to generate the bare minimum HTML.
result = newStringTable(modeStyleInsensitive) result = newStringTable(modeStyleInsensitive)
template setConfigVar(key, val: expr) = template setConfigVar(key, val: expr) =