jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Nim/doc
History
Timothee Cour 1018f51fce
 workaround #17091: manual.rst now renders as RST in github (#17092)
2021-02-19 15:35:34 +01:00
..
manual Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
advopt.txt document since (#17048) 2021-02-16 20:20:01 +01:00
apis.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
astspec.txt fix docs typo (#16637) 2021-01-12 14:08:24 +08:00
backends.rst Add note about minimum Node.js version (#16370) 2020-12-16 16:05:59 +00:00
basicopt.txt new: nim -e:cmd to run a command directly; also fixes #15731 (#15687) 2020-11-09 16:07:22 +01:00
contributing.rst contributing: prefer assert to doAssert in runnableExamples (#17077) 2021-02-18 13:19:38 -08:00
destructors.rst Reboot of #16195 (#16746) 2021-01-20 11:05:56 +01:00
docgen.rst conservative approach to fix #15184 (#16723) 2021-01-15 00:53:36 +01:00
docgen_sample.nim fix #13218: avoid some irrelevant warnings for nim doc,rst2html,--app:lib, + other fixes (#13550) 2020-03-13 20:42:41 +01:00
docs.rst Documentation update a description (#14619) 2020-06-09 22:17:32 +01:00
docstyle.rst rst: single backticks now render correctly in both rst2html and github (#17028) 2021-02-13 09:30:23 +01:00
drnim.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
effects.txt Nimrod renamed to Nim 2014-08-28 22:36:14 +02:00
estp.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
filelist.txt Fix Typos in Internal Docs (#11735) [ci skip] 2019-07-15 19:05:23 +02:00
filters.rst fix #9647 tmpl=>nimf (#9658) 2018-11-14 08:27:48 +01:00
gc.rst Add short description on GC (#16535) 2021-01-01 18:36:20 +01:00
grammar.txt small fix in grammar.txt [ci skip] 2021-01-28 09:42:24 +01:00
hcr.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
idetools.rst Deprecate TaintedString (#15423) 2021-01-15 18:56:38 -08:00
intern.rst Syntax (RST) fix Internals of the Compiler (#16341) 2020-12-15 14:57:11 +01:00
keywords.txt language change: 'generic' and 'atomic' are not keywords anymore 2017-11-21 11:27:35 +01:00
koch.rst fix ./koch pdf command (#16989) 2021-02-09 22:46:51 +01:00
lib.rst add system random to stdlib: std/sysrand (#16459) 2021-02-11 16:00:01 -08:00
manual.rst workaround #17091: manual.rst now renders as RST in github (#17092) 2021-02-19 15:35:34 +01:00
manual_experimental.rst tests and docs for call operator (#16980) 2021-02-09 12:18:16 +01:00
manual_experimental_strictnotnil.rst Nil type check implementation (#15287) 2020-12-29 10:31:11 +01:00
mytest.cfg '#' value parcing is explained (disambiguated) (#12476) 2019-10-25 15:22:26 +02:00
nep1.rst followup #17065 (#17090) 2021-02-18 11:24:21 -08:00
nimc.rst remove all mentions of doc2, jsondoc2 (except 1 mentioning the alias) (#15683) 2020-11-26 11:54:18 -08:00
nimdoc.css RST: implement footnotes and citations (#16960) 2021-02-15 14:12:40 +01: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 Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
nims.rst Fixing unexistant word in PT (#17070) 2021-02-17 15:49:23 +01:00
nimsuggest.rst Updated nimsuggest doc to explain connection to nim compiler and use of config files (#16869) 2021-02-01 13:17:19 +01:00
overview.rst further cleanups; refs #4934 2016-10-24 12:20:51 +02:00
packaging.rst [backport] Add links to packaging and distro pages (#12603) [ci skip] 2019-11-06 09:03:28 +01:00
pegdocs.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
prelude.rst Documentation prelude (#15377) 2020-09-21 12:37:14 +02:00
readme.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
regexprs.txt fixed article duplication typos (#16216) 2020-12-02 09:15:29 +01:00
sets_fragment.txt Fix many broken links 2019-10-22 17:59:12 -07:00
spawn.txt renames threadpool.await to blockUntil; refs #7853 2018-08-14 01:28:04 +02:00
subexes.txt more "eg" fixes 2020-10-20 10:51:50 +02:00
testament.rst testament: error instead of silently ignore invalid targets; remove pointless alias target vs targets; document matrix; DRY (#16343) 2020-12-14 10:58:29 +01:00
tools.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
tut1.rst add link to Nim Basics in tut1.rst [ci skip] 2021-01-20 09:15:20 +01:00
tut2.rst remove all mentions of doc2, jsondoc2 (except 1 mentioning the alias) (#15683) 2020-11-26 11:54:18 -08:00
tut3.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00

readme.txt 

============================
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!