summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorGrzegorz Adam Hankiewicz <gradha@imap.cc>2014-01-06 13:40:11 +0100
committerGrzegorz Adam Hankiewicz <gradha@imap.cc>2014-01-06 13:40:11 +0100
commit91ae5a3585d93c94d1dba45c9c607496945bce0e (patch)
tree3bf0a7ff67dfbac6a114d79ead48342edb27abac /doc
parent5844697aa6875b03fb4b7df4ccbcb824a3c1e1c1 (diff)
downloadNim-91ae5a3585d93c94d1dba45c9c607496945bce0e.tar.gz
Adds some cross references to docgen manual.
Diffstat (limited to 'doc')
-rw-r--r--doc/docgen.txt12
-rw-r--r--doc/nimrodc.txt7
2 files changed, 13 insertions, 6 deletions
diff --git a/doc/docgen.txt b/doc/docgen.txt
index 0e897dcd5..2ef06e578 100644
--- a/doc/docgen.txt
+++ b/doc/docgen.txt
@@ -11,12 +11,12 @@
 Introduction
 ============
 
-This document describes the documentation generation tools built into the
-*Nimrod compiler*, which can generate HTML and JSON output from input .nim
-files and projects, as well as HTML and LaTeX from input RST (reStructuredText)
-files. The output documentation will include module dependencies (``import``),
-any top-level documentation comments (##), and exported symbols (*), including
-procedures, types, and variables.
+This document describes the `documentation generation tools`:idx: built into
+the `Nimrod compiler <nimrodc.html>`_, which can generate HTML and JSON output
+from input .nim files and projects, as well as HTML and LaTeX from input RST
+(reStructuredText) files. The output documentation will include module
+dependencies (``import``), any top-level documentation comments (##), and
+exported symbols (*), including procedures, types, and variables.
 
 
 Documentation Comments
diff --git a/doc/nimrodc.txt b/doc/nimrodc.txt
index f5fbf3ebb..52e0a6eaf 100644
--- a/doc/nimrodc.txt
+++ b/doc/nimrodc.txt
@@ -538,6 +538,13 @@ on Linux::
   nimrod c --dynlibOverride:lua --passL:liblua.lib program.nim
 

 

+Nimrod documentation tools
+==========================
+
+Nimrod provides the `doc`:idx: and `doc2`:idx: commands to generate HTML
+documentation from ``.nim`` source files. Only exported symbols will appear in
+the output. For more details `see the docgen documentation <docgen.html>`_.
+
 Nimrod idetools integration

 ===========================