mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-01-05 04:27:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7cf698442a4a97ca7d1694100992c67de4d2823a
Nim/doc
History
PMunch b70b633e8e Fixes #9364 and add moduleDescription to jsondoc (#9396) 
This fixes `jsondoc0` so that it has comments in the output as described
by the documentation. It also fixes `jsondoc`/`jsondoc2` as it stored
it's output in a file with an html extension. Along with this it also
adds a new field `moduleDescription` to `jsondoc`/`jsondoc2` which
contains the module description.

(cherry picked from commit db95fad6fa)
2018-11-01 17:47:27 +01:00
..
manual
improve documentation for 'var T return values'; refs #7373
2018-04-21 17:01:33 +02:00
advopt.txt
improve the compiler option "cppCompileToNamespace", a custom namespace can now be set
2018-09-15 20:10:54 +09:00
apis.rst
integrate 'koch web' features into koch; deprecate 'nimweb' tool
2018-09-13 18:47:53 +02:00
astspec.txt
Fixed a wrong AST example (#8269)
2018-07-11 08:52:09 +02:00
backends.rst
more documentation improvements; fixes #9119
2018-09-29 20:10:44 +02:00
basicopt.txt
better doc for hard to find --define:SYMBOL:VAL (#8257)
2018-07-11 10:33:33 +02:00
contributing.rst
Testament pre parallel (#9137)
2018-11-01 17:35:08 +01:00
docgen_sample.nim
Transforms docgen sample to be generated from source.
2014-01-06 14:55:03 +01:00
docgen.rst
Fixes #9364 and add moduleDescription to jsondoc (#9396)
2018-11-01 17:47:27 +01:00
docs.rst
docs: remove most stale links; refs #9109
2018-09-29 11:23:29 +02:00
docstyle.rst
further cleanups; refs #4934
2016-10-24 12:20:51 +02:00
effects.txt
Nimrod renamed to Nim
2014-08-28 22:36:14 +02:00
endb.rst
Removed space between "array" and a square bracket in the docs
2018-05-19 20:28:27 +03:00
estp.rst
renamed most remaining .txt documentation files to .rst
2016-06-07 04:04:49 +02:00
filelist.txt
fixes #2559
2015-09-10 10:50:29 +02:00
filters.rst
renamed most remaining .txt documentation files to .rst
2016-06-07 04:04:49 +02:00
gc.rst
docs for the heap dump feature
2017-01-16 23:04:53 +01:00
grammar.txt
added the 'x.p[:T]' notation for explicit generic instantiations in combination with the ddot calling syntax
2018-04-06 22:05:57 +02:00
idetools.rst
renamed most remaining .txt documentation files to .rst
2016-06-07 04:04:49 +02:00
intern.rst
[Docs] Attribute citation to Richard Gabriel
2018-09-22 13:57:28 +02:00
keywords.txt
language change: 'generic' and 'atomic' are not keywords anymore
2017-11-21 11:27:35 +01:00
koch.rst
Testament pre parallel (#9137)
2018-11-01 17:35:08 +01:00
lib.rst
manual: Fix links to Parallel & Spawn (#9342)
2018-11-01 17:36:02 +01:00
manual.rst
manual: Fix links to Parallel & Spawn (#9342)
2018-11-01 17:36:02 +01:00
mytest.cfg
docs: document that --flag is same as flag in cfg config files (#8430)
2018-07-30 10:17:41 +02:00
nep1.rst
add the apis.txt table to nep1.rst
2018-07-09 12:35:25 +02:00
nimc.rst
fixes #9244
2018-11-01 17:46:31 +01:00
nimdoc.css
Add NEP1 to documentation.
2015-07-10 03:51:00 -04: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
Update config.nims search path in docs (#9388)
2018-11-01 17:47:02 +01:00
nimsuggest.rst
Fixes some minor typos in nimsuggest.rst (#9223)
2018-11-01 17:27:10 +01:00
overview.rst
further cleanups; refs #4934
2016-10-24 12:20: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
doc: Trim .txt files trailing whitespace
2015-09-04 23:10:48 +02:00
sets_fragment.txt
Tut 1: tiny improvements
2018-02-05 21:13:18 +01: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
more documentation improvements; fixes #9119
2018-09-29 20:10:44 +02:00
tut1.rst
Tutorial 1: Simplifiy the discription of enums; it is a tutorial, not a manual
2018-08-31 00:30:19 +02:00
tut2.rst
document the new type[T] and static[T] features
2018-06-16 16:46:32 +03: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!