mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-30 18:02:05 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5bad022d58e21f0da455fbd7d421cd26a2b5c812
Nim/doc
History
Andrey Makarov e7816a3e77 update docgen documentation (#18192) 
* update docgen documentation

* --fullhelp

* Update doc/docgen.rst

Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>

* [skip ci] fix typos

Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
2021-06-06 09:55:20 +02:00
..
manual
turn on syntax highlighting in Manual & Tutorial (#17692)
2021-04-11 10:23:08 +02:00
advopt.txt
update docgen documentation (#18192)
2021-06-06 09:55:20 +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
[ci skip] correctly explain how to use [backport] tags
2021-05-12 13:57:43 +02:00
destructors.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +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
docgen.rst
update docgen documentation (#18192)
2021-06-06 09:55:20 +02: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_experimental_strictnotnil.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
manual_experimental.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
manual.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
change --hint[X] => --hint:X in nim repo (avoids shell quoting issues) (#18085)
2021-05-26 09:51:48 +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_cmdline.txt
update nimgrep documentation (#17415)
2021-03-23 18:12:27 +01:00
nimgrep.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
niminst.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
nims.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +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
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16: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
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
turn on syntax highlighting in Manual & Tutorial (#17692)
2021-04-11 10:23:08 +02:00
tut3.rst
turn on syntax highlighting in Manual & Tutorial (#17692)
2021-04-11 10:23:08 +02: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!