mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-28 17:04:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
acadda8da281fbe796386ba05ffab957883f0fef
Nim/doc
History
Timothee Cour 58282547f6 fix #6583, fix #14376, index+search now generated for all projects, many bug fixes with nim doc (#14324) 
* refs #6583 fix nim doc output
* changelog
* change default for outDir when unspecified
* cleanups
* --project implies --index
2020-05-25 13:25:40 +02:00
..
manual
deviated -> derived (#12846) [backport]
2019-12-08 20:15:19 +01:00
advopt.txt
nim doc --backend:js, nim doc --doccmd:-d:foo, nim r --backend:js, --doccmd:skip + other improvements (#14278)
2020-05-11 12:01:18 +02: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
nim doc --backend:js, nim doc --doccmd:-d:foo, nim r --backend:js, --doccmd:skip + other improvements (#14278)
2020-05-11 12:01: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
fixes #13881
2020-05-12 15:46:24 +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
fix #6583, fix #14376, index+search now generated for all projects, many bug fixes with nim doc (#14324)
2020-05-25 13:25:40 +02: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
make from an operator (#14241)
2020-05-08 07:54:46 +02:00
hcr.rst
docs: fix syntax error in hotCodeReloading example (fixes #14380) (#14381)
2020-05-17 12:44:36 +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_experimental.rst
Fix typo
2020-05-08 16:13:53 +02:00
manual.rst
manual.rst: updates [backport] (#14445)
2020-05-25 12:16:32 +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

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!