summary refs log tree commit diff stats
path: root/doc/docgen.rst
diff options
context:
space:
mode:
authorPMunch <peterme@peterme.net>2018-10-17 00:34:47 +0200
committerAndreas Rumpf <rumpf_a@web.de>2018-10-17 00:34:47 +0200
commitdb95fad6fa03bcd734fc406a675ead3e07e64570 (patch)
treee2f98d88c37a5fb811acb673b2975d80efeee5b3 /doc/docgen.rst
parente8cf289beeb54b8e6d3d1e42c7571d037109caf0 (diff)
downloadNim-db95fad6fa03bcd734fc406a675ead3e07e64570.tar.gz
Fixes #9364 and add moduleDescription to jsondoc (#9396)
This fixes `jsondoc0` so that it has comments in the output as described
by the documentation. It also fixes `jsondoc`/`jsondoc2` as it stored
it's output in a file with an html extension. Along with this it also
adds a new field `moduleDescription` to `jsondoc`/`jsondoc2` which
contains the module description.
Diffstat (limited to 'doc/docgen.rst')
-rw-r--r--doc/docgen.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/docgen.rst b/doc/docgen.rst
index 65c7bd908..e6604d3bd 100644
--- a/doc/docgen.rst
+++ b/doc/docgen.rst
@@ -117,6 +117,7 @@ Output::
   {
     "orig": "docgen_sample.nim",
     "nimble": "",
+    "moduleDescription": "This module is a sample",
     "entries": [
       {
         "name": "helloWorld",