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

Adds some cross references to docgen manual.

Browse source
This commit is contained in:
Grzegorz Adam Hankiewicz 2014-01-06 13:40:11 +01:00
commit 91ae5a3585
2 changed files with 13 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/docgen.txt
View file

@ -11,12 +11,12 @@
Introduction Introduction
============ ============
This document describes the documentation generation tools built into the This document describes the `documentation generation tools`:idx: built into
*Nimrod compiler*, which can generate HTML and JSON output from input .nim the `Nimrod compiler <nimrodc.html>`_, which can generate HTML and JSON output
files and projects, as well as HTML and LaTeX from input RST (reStructuredText) from input .nim files and projects, as well as HTML and LaTeX from input RST
files. The output documentation will include module dependencies (``import``), (reStructuredText) files. The output documentation will include module
any top-level documentation comments (##), and exported symbols (*), including dependencies (``import``), any top-level documentation comments (##), and
procedures, types, and variables. exported symbols (*), including procedures, types, and variables.
Documentation Comments Documentation Comments

7
doc/nimrodc.txt
View file

@ -538,6 +538,13 @@ on Linux::
nimrod c --dynlibOverride:lua --passL:liblua.lib program.nim 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 Nimrod idetools integration
=========================== ===========================