Nim/doc
Andreas Rumpf 01fc9e58ca
fixes #18550 (#18553)
* fixes #18550

* update the manual to reflect reality
2021-07-21 16:55:50 +02:00
..
manual turn on syntax highlighting in Manual & Tutorial (#17692) 2021-04-11 10:23:08 +02:00
advopt.txt followup #17852, disallow all:on for now (#18311) 2021-06-20 22:49:14 +02:00
apis.rst follow-up #17692: more inline syntax highlighting (#17837) 2021-04-29 17:16:14 +02:00
astspec.txt unify tuple expressions (#13793) 2021-03-30 02:06:51 +02:00
backends.rst follow-up #17692: more inline syntax highlighting (#17837) 2021-04-29 17:16:14 +02: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 breaking changes policies (#18541) 2021-07-21 10:22:30 +02:00
destructors.rst Improve description of how =trace is used (#18491) 2021-07-15 14:35:53 +02:00
docgen.rst update docgen documentation (#18192) 2021-06-06 09:55:20 +02: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 add RST highlighting for command line / shells (also fixes #16858) (#17789) 2021-04-21 16:57:54 +02:00
drnim.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
effects.txt Nimrod renamed to Nim 2014-08-28 22:36:14 +02:00
estp.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
filelist.txt follow-up #17837: add Console for interactive sessions (#17930) 2021-05-06 10:58:01 +02:00
filters.rst change --hint[X] => --hint:X in nim repo (avoids shell quoting issues) (#18085) 2021-05-26 09:51:48 +02:00
gc.rst follow-up #17930 - inline syntax highlighting (#18013) 2021-05-16 23:55:14 +02:00
grammar.txt custom integer literals (#17489) 2021-03-24 14:46:19 +01:00
hcr.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
idetools.rst RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) (#17258) 2021-03-18 20:37:55 -07:00
intern.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
keywords.txt language change: 'generic' and 'atomic' are not keywords anymore 2017-11-21 11:27:35 +01:00
koch.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
lib.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
manual.rst fixes #18550 (#18553) 2021-07-21 16:55:50 +02:00
manual_experimental.rst use more .} (#18542) 2021-07-20 20:12:15 +08:00
manual_experimental_strictnotnil.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
mytest.cfg '#' value parcing is explained (disambiguated) (#12476) 2019-10-25 15:22:26 +02:00
nep1.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
nimc.rst added nimAllocPagesViaMalloc switch (#18490) 2021-07-15 17:58:47 +02:00
nimdoc.css follow-up #17837: add Console for interactive sessions (#17930) 2021-05-06 10:58:01 +02:00
nimfix.rst RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) (#17258) 2021-03-18 20:37:55 -07:00
nimgrep.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
nimgrep_cmdline.txt update nimgrep documentation (#17415) 2021-03-23 18:12:27 +01:00
niminst.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
nims.rst Update nims.rst to reflect that -d:release is now allowed in config.nims (#18221) 2021-06-10 14:29:03 +02:00
nimsuggest.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
overview.rst further cleanups; refs #4934 2016-10-24 12:20:51 +02:00
packaging.rst Switch packaging.rst to use makefile 2021-06-27 19:51:28 +01:00
pegdocs.txt Peg captures get stack-like behavior (#18369) 2021-06-28 12:33:20 +02:00
readme.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
regexprs.txt follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
rstcommon.rst follow-up #17692: more inline syntax highlighting (#17837) 2021-04-29 17:16:14 +02:00
sets_fragment.txt small improvements for tut1.rst (#17935) 2021-05-05 07:44:33 +02: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 follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
tools.rst follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
tut1.rst Minor doc fixes; follow up to 17258 and 17259 (#18123) 2021-05-29 12:39:46 -07:00
tut2.rst Add commas to docs for clarity (#18398) 2021-06-29 19:21:30 -07:00
tut3.rst turn on syntax highlighting in Manual & Tutorial (#17692) 2021-04-11 10:23:08 +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!