Nim/doc
2018-04-06 11:59:49 +02:00
..
manual fix small typo in the documentation (#7411) 2018-03-26 09:48:39 +02:00
advopt.txt cmd line help: clarify compileOnly vs noLinking 2018-04-05 14:34:55 -07:00
apis.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
astspec.txt Ast and concrete syntax different. 2018-01-08 13:30:09 +01:00
backends.txt minor documentation update 2017-11-22 23:19:12 +01:00
basicopt.txt 'nim doc' is now using version 2 of the documentation generator 2017-11-16 12:53:36 +01:00
contributing.rst website: http to https updates 2017-02-06 22:43:07 +01:00
docgen.rst Renamed jsondoc2 to jsondoc, similar to doc2 (#7279) 2018-03-08 15:11:45 +01: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 Fix casing in rule 'typeDesc' (#7324) 2018-03-12 09:27:36 +01: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 language change: 'generic' and 'atomic' are not keywords anymore 2017-11-21 11:27:35 +01:00
koch.rst website: http to https updates 2017-02-06 22:43:07 +01:00
lib.rst renamed future.nim to sugar.nim 2018-04-06 11:59:49 +02: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 doc: fix path to $HOME/.config/nim.cfg to work on POSIX (not just unix but also osx) (#7421) 2018-03-27 09:45:43 +02: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 Tut 1: tiny improvements 2018-02-05 21:13:18 +01: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 more documentation fixes 2018-03-05 23:25:50 +01:00
tut1.rst Tut 1: tiny improvements 2018-02-05 21:13:18 +01:00
tut2.rst test the snippets in tut2.rst 2017-11-28 01:25:59 +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!