Nim/doc
2020-05-08 18:48:44 -06:00
..
manual deviated -> derived (#12846) [backport] 2019-12-08 20:15:19 +01:00
advopt.txt Add ability for rst parser to continue on errors 2020-05-08 18:48:44 -06:00
apis.rst Discussion both in (#12678) 2019-11-20 08:39:45 +01:00
astspec.txt Prefer relative links for Nim documentation 2019-10-22 17:59:12 -07:00
backends.rst Clarify JS cstring len (#14184) 2020-05-05 10:34:37 +02:00
basicopt.txt new cmd: nim r main [args...] to compile & run, saving binary under $nimcache/main (#13382) 2020-04-23 10:02:18 +02:00
codeowners.rst Fixes #9671 (#9750) 2018-11-19 09:22:21 +01:00
contributing.rst drnim: tiny progress (#13882) 2020-04-15 20:03:25 +02:00
destructors.rst changed type() to typeof() in docs and error messages (#14084) 2020-04-24 09:22:12 +02:00
docgen.rst Add --git.devel option to the documentation 2019-12-15 12:45:57 +00: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 Add link to tutorial part III to docs.rst (#10157) [ci skip] 2019-01-01 19:49:29 +01:00
docstyle.rst fixup 2019-02-05 17:45:30 -08:00
drnim.rst drnim: tiny progress (#13882) 2020-04-15 20:03:25 +02: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 gc.rst that doesn't lie (#13686) 2020-03-19 06:41:54 +01:00
grammar.txt Update grammar.txt with func and as (#14147) [backport] 2020-04-28 10:57:35 +02:00
hcr.rst Update code example to match new sdl2.nim syntax (#13924) 2020-04-20 14:49:05 +02:00
idetools.rst Fix word wrapping 2019-10-22 17:59:12 -07:00
intern.rst [backport] Fix spelling typos (#12755) 2019-11-28 08:30:55 +01:00
keywords.txt language change: 'generic' and 'atomic' are not keywords anymore 2017-11-21 11:27:35 +01:00
koch.rst only enable linenoise for -d:nimUseLinenoise (#13478) 2020-02-24 11:06:39 +01:00
lib.rst Error -> Defect for defects (#13908) 2020-04-28 19:56:01 +02:00
manual.rst exp. features now in correct manual, closes #11932 (#14195) 2020-05-02 22:30:08 +02:00
manual_experimental.rst exp. features now in correct manual, closes #11932 (#14195) 2020-05-02 22:30:08 +02:00
mytest.cfg '#' value parcing is explained (disambiguated) (#12476) 2019-10-25 15:22:26 +02:00
nep1.rst add the apis.txt table to nep1.rst 2018-07-09 12:35:25 +02:00
nimc.rst added a new feature: --cc:env so that you can use any C compiler as long as it works like GCC 2020-05-06 18:41:24 +02:00
nimdoc.css Fix #13972 (#14034) 2020-04-20 17:06:44 +02: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 StringStream & more stdlib modules support for JS/NimScript (#14095) 2020-04-28 19:44:52 +02:00
nimsuggest.rst Fix word wrapping 2019-10-22 17:59:12 -07: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
readme.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
regexprs.txt fixes #9471 (#10502) 2019-01-30 19:49:09 +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 s/advanted/advanced/g 2015-09-20 18:16:51 -07:00
tools.rst [backport] Documentation Fix #12251 (#13226) [ci skip] 2020-01-22 17:56:44 +01:00
tut1.rst [backport] tut1: Update the proc overloading examples (#13497) [skip ci] 2020-02-25 21:19:51 +01:00
tut2.rst Error -> Defect for defects (#13908) 2020-04-28 19:56:01 +02:00
tut3.rst Error -> Defect for defects (#13908) 2020-04-28 19:56:01 +02: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!