Nim/doc
flywind e1cc3b83fb
deprecate newruntime (#17245)
* deprecate newruntime
* tests
* Update compiler/commands.nim
2021-03-04 19:33:16 +01:00
..
manual Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
advopt.txt deprecate newruntime (#17245) 2021-03-04 19:33:16 +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 followup #17077: also use assert instead of doAssert for code-block rst blocks intended to be used as runnableExamples (#17122) 2021-02-21 23:44:32 +08:00
destructors.rst rename prepareStrMutation to prepareMutation (#17235) 2021-03-03 08:08:52 +08:00
docgen.rst promote std prefix in docs (#17128) 2021-02-20 22:38:29 -08: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 stricter checks for RST headlines (#17089) 2021-02-20 18:01:45 +01:00
grammar.txt small fix in grammar.txt [ci skip] 2021-01-28 09:42:24 +01:00
hcr.rst Change stdlib imports to use std prefix in most examples (#17202) 2021-02-28 13:17:19 -08:00
idetools.rst Deprecate TaintedString (#15423) 2021-01-15 18:56:38 -08:00
intern.rst promote std prefix in docs (#17128) 2021-02-20 22:38:29 -08: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 enumutils.items for sparse enums, typetraits.SomeSparseEnum (#17080) 2021-02-23 20:25:35 +01:00
manual.rst Change stdlib imports to use std prefix in most examples (#17202) 2021-02-28 13:17:19 -08:00
manual_experimental.rst promote std prefix in docs (#17128) 2021-02-20 22:38:29 -08:00
manual_experimental_strictnotnil.rst stricter checks for RST headlines (#17089) 2021-02-20 18:01:45 +01:00
mytest.cfg '#' value parcing is explained (disambiguated) (#12476) 2019-10-25 15:22:26 +02:00
nep1.rst Remove the note about old naming conventions (#17222) 2021-03-02 10:26:07 +01:00
nimc.rst deprecate newruntime (#17245) 2021-03-04 19:33:16 +01:00
nimdoc.css RST heading improvements (fix #17091) (#17195) 2021-03-02 16:41:10 +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 promote std prefix in docs (#17128) 2021-02-20 22:38:29 -08: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
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 Change stdlib imports to use std prefix in most examples (#17202) 2021-02-28 13:17:19 -08:00
subexes.txt more "eg" fixes 2020-10-20 10:51:50 +02:00
testament.rst remove tests/deps/ (#17132) 2021-02-23 13:31:53 +01:00
tools.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
tut1.rst promote std prefix in docs (#17128) 2021-02-20 22:38:29 -08:00
tut2.rst promote std prefix in docs (#17128) 2021-02-20 22:38:29 -08:00
tut3.rst promote std prefix in docs (#17128) 2021-02-20 22:38:29 -08: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!