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

Fixes two minor typos.

Browse source
This commit is contained in:
Grzegorz Adam Hankiewicz 2014-01-06 13:18:27 +01:00
commit 0b6c9d7d75
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/docgen.txt
View file

@ -13,14 +13,14 @@ Introduction
This document describes the documentation generation tools built into the *Nimrod compiler*, 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 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 and LaTeX from input RST (reStructuredText) files. The output documentation will include
module dependencies (``import``), any top-level documentation comments (##), and exported module dependencies (``import``), any top-level documentation comments (##), and exported
symbols (*), including procedures, types, and variables. symbols (*), including procedures, types, and variables.
Documentation Comments Documentation Comments
---------------------- ----------------------
Any comments which are preceeded by a double-hash (##), are interpreted as documentation. Any comments which are preceded by a double-hash (##), are interpreted as documentation.
Comments are parsed as RST Comments are parsed as RST
(see `reference <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_), providing (see `reference <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_), providing
Nimrod module authors the ability to easily generate richly formatted documentation with only Nimrod module authors the ability to easily generate richly formatted documentation with only