Nim/doc
Fredrik Høisæther Rasch 6652ae9741 Creating and setting comment nodes in macros (#5850)
* strVal assingnable comment statement ast nodes
* Set comment instead of strVal for comment nodes
* Added test code for creating and setting comment nodes
* Modified the AST spec documentation for documentation comments
2017-05-31 13:08:08 +02:00
..
manual fix affecting templates with explicit generic params 2017-05-13 20:48:44 +03:00
advopt.txt kill the reportConceptFailures options as it will be replaced by the .explain. pragma 2017-03-24 16:58:15 +02:00
apis.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
astspec.txt Creating and setting comment nodes in macros (#5850) 2017-05-31 13:08:08 +02:00
backends.txt Add `tearDownForeignThreadGc` function (#5369) 2017-02-13 13:37:20 +01:00
basicopt.txt new dependency tracking for nimsuggest 2016-11-06 17:33:33 +01:00
contributing.rst website: http to https updates 2017-02-06 22:43:07 +01:00
docgen.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
docgen_sample.nim Transforms docgen sample to be generated from source. 2014-01-06 14:55:03 +01:00
docs.rst further cleanups; refs #4934 2016-10-24 12:20:51 +02:00
docstyle.rst further cleanups; refs #4934 2016-10-24 12:20:51 +02:00
effects.txt Nimrod renamed to Nim 2014-08-28 22:36:14 +02:00
endb.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
estp.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
exception_hierarchy_fragment.txt Fixed links in Error hierarchy 2015-06-04 16:18:18 -04:00
filelist.txt fixes #2559 2015-09-10 10:50:29 +02:00
filters.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
gc.rst docs for the heap dump feature 2017-01-16 23:04:53 +01:00
grammar.txt assignments support ': stmtList' like let/var do 2017-04-04 12:20:43 +02:00
idetools.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
intern.txt inter.txt: fix git bisect example (#5722) 2017-04-19 00:36:28 +02:00
keywords.txt breaking change: 'concept' is now a keyword and used instead of 'generic' 2015-03-23 13:10:18 +01:00
koch.rst website: http to https updates 2017-02-06 22:43:07 +01:00
lib.rst Mentioned that critbits is sorted... (#5524) 2017-03-14 15:07:45 +01:00
manual.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
mytest.cfg Removes executable bit for text files. 2013-03-16 23:53:07 +01:00
nep1.rst Cleaned up nep1 and simplified the style choices offered by it. 2017-03-16 22:34:49 +01:00
nimc.rst abi check: prefer nim constant to enable, document 2016-11-03 22:30:00 +08:00
nimdoc.css Add NEP1 to documentation. 2015-07-10 03:51:00 -04:00
nimfix.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
nimgrep.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
niminst.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
nims.rst Documented shebang execution of Nimscripts 2017-05-21 22:19:13 +01:00
nimsuggest.rst nimsuggest: update documentation 2017-03-08 12:44:57 +01:00
overview.rst further cleanups; refs #4934 2016-10-24 12:20:51 +02:00
pegdocs.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
readme.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
regexprs.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
sets_fragment.txt Misc documentation fixes 2016-09-17 15:53:12 +02:00
spawn.txt documented the new .gcsafe override pragma 2017-01-20 20:32:41 +01:00
subexes.txt s/advanted/advanced/g 2015-09-20 18:16:51 -07:00
tools.txt fix docgen link 2015-11-07 09:33:55 +01:00
tut1.rst tut1.rst: Fix alignment, Change Subrange to MySubrange for clarity (#5798) 2017-05-13 21:52:19 +02:00
tut2.rst Further tutorial updates (#5176) 2017-01-07 09:18:45 +01:00

============================
Nim's documenation system
============================

This folder contains Nim's documentation. The documentation
is written in a format called *reStructuredText*, a markup language that reads
like ASCII and can be converted to HTML automatically!