summary refs log tree commit diff stats
path: root/lib/packages
diff options
context:
space:
mode:
authorAraq <rumpf_a@web.de>2014-01-18 01:16:45 +0100
committerAraq <rumpf_a@web.de>2014-01-18 01:16:45 +0100
commit36afdca87f3757c8468cbfa622de693447df7e07 (patch)
tree3b739b667574c12dea389a17d9d84291fd355463 /lib/packages
parent5073914b8697a9fd1dc38bebef434b50850f2861 (diff)
parent3f8bfb1e988322ab60cc54184d63a00906260665 (diff)
downloadNim-36afdca87f3757c8468cbfa622de693447df7e07.tar.gz
resolved conflicts with master
Diffstat (limited to 'lib/packages')
-rw-r--r--lib/packages/docutils/rstgen.nim13
1 files changed, 12 insertions, 1 deletions
diff --git a/lib/packages/docutils/rstgen.nim b/lib/packages/docutils/rstgen.nim
index 5afd70319..a56f62448 100644
--- a/lib/packages/docutils/rstgen.nim
+++ b/lib/packages/docutils/rstgen.nim
@@ -699,7 +699,18 @@ proc formatNamedVars*(frmt: string, varnames: openArray[string],
 
 
 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)
   
   template setConfigVar(key, val: expr) =