mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-04-18 21:40:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

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
parent 5844697aa6
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
============
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

7
doc/nimrodc.txt
View File

@@ -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
===========================