Nim/doc
2018-10-12 09:00:27 +02:00
..
manual improve documentation for 'var T return values'; refs #7373 2018-04-21 17:01:33 +02:00
advopt.txt improve the compiler option "cppCompileToNamespace", a custom namespace can now be set 2018-09-15 20:10:54 +09:00
apis.rst integrate 'koch web' features into koch; deprecate 'nimweb' tool 2018-09-13 18:47:53 +02:00
astspec.txt Fixed a wrong AST example (#8269) 2018-07-11 08:52:09 +02:00
backends.rst more documentation improvements; fixes #9119 2018-09-29 20:10:44 +02:00
basicopt.txt better doc for hard to find --define:SYMBOL:VAL (#8257) 2018-07-11 10:33:33 +02:00
codeowners.rst Align to the actual experience (#9324) 2018-10-12 08:49:33 +02:00
contributing.rst update contributing.rst and added codeowners.rst 2018-10-11 13:45:37 +02:00
docgen.rst docs: remove most stale links; refs #9109 2018-09-29 11:23:29 +02:00
docgen_sample.nim Transforms docgen sample to be generated from source. 2014-01-06 14:55:03 +01:00
docs.rst docs: remove most stale links; refs #9109 2018-09-29 11:23:29 +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 Removed space between "array" and a square bracket in the docs 2018-05-19 20:28:27 +03:00
estp.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02: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 added the 'x.p[:T]' notation for explicit generic instantiations in combination with the ddot calling syntax 2018-04-06 22:05:57 +02:00
idetools.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
intern.rst [Docs] Attribute citation to Richard Gabriel 2018-09-22 13:57:28 +02:00
keywords.txt language change: 'generic' and 'atomic' are not keywords anymore 2017-11-21 11:27:35 +01:00
koch.rst remove hardly used TimeMachine feature 2018-05-06 20:07:42 +02:00
lib.rst [cleanup] remove xmldom and xmldomparser (#9234) 2018-10-09 20:58:56 +02:00
manual.rst manual: Remove stmt or expr template related text from manual (#9321) 2018-10-12 09:00:27 +02:00
mytest.cfg docs: document that --flag is same as flag in cfg config files (#8430) 2018-07-30 10:17:41 +02:00
nep1.rst add the apis.txt table to nep1.rst 2018-07-09 12:35:25 +02:00
nimc.rst docs: remove most stale links; refs #9109 2018-09-29 11:23:29 +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 Fix RST formatting; reword a notice about -d:release in .nims 2018-09-25 08:42:19 -04:00
nimsuggest.rst Fixes some minor typos in nimsuggest.rst (#9223) 2018-10-09 17:45:00 +02: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 renames threadpool.await to blockUntil; refs #7853 2018-08-14 01:28:04 +02:00
subexes.txt s/advanted/advanced/g 2015-09-20 18:16:51 -07:00
tools.rst more documentation improvements; fixes #9119 2018-09-29 20:10:44 +02:00
tut1.rst Tutorial 1: Simplifiy the discription of enums; it is a tutorial, not a manual 2018-08-31 00:30:19 +02:00
tut2.rst document the new type[T] and static[T] features 2018-06-16 16:46:32 +03: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!