Nim/doc
2018-07-02 11:33:08 +09:00
..
manual improve documentation for 'var T return values'; refs #7373 2018-04-21 17:01:33 +02:00
advopt.txt Add docs for compiler switch 2018-07-02 11:33:08 +09:00
apis.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
astspec.txt Get symbol kind (#7491) 2018-04-11 16:48:01 +02:00
backends.txt minor documentation update 2017-11-22 23:19:12 +01:00
basicopt.txt remove dead code elimination option (#7669) 2018-04-23 11:02:38 +02:00
contributing.rst website: http to https updates 2017-02-06 22:43:07 +01:00
docgen.rst document the new type[T] and static[T] features 2018-06-16 16:46:32 +03: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 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
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 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.txt WIP: an API for VM replay global state support 2018-06-03 20:18:43 +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 Support code hot reloading for JavaScript projects (#7362) 2018-04-13 19:08:43 +02:00
manual.rst Clarify use of special : for passing a block of stmts to template (#8133) 2018-06-27 21:37:31 +02:00
mytest.cfg Removes executable bit for text files. 2013-03-16 23:53:07 +01:00
nep1.rst Revert "[RFC] NEP-1.1. Relax 80 chars requirement." 2018-06-09 18:39:33 +01:00
nimc.rst Add docs for compiler switch 2018-07-02 11:33:08 +09: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 Changed tutorial documentation referring to 'constant' to 'immutable' (#8056) 2018-06-18 02:05:35 -04: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!