Nim/doc
Miran b03de8a4d9
Fix many broken links and prefer relative links within docs (#12463)
* Fix many broken links

Note that contrary to what docgen.rst currently says, the ids have
to match exactly or else most web browsers will not jump to the
intended symbol.

* Prefer relative links for Nim documentation

This is more friendly to those browsing the documentation without
a network connection. The nim-doc package in Debian allows this,
for example.

Also, the domain name being used was not consistent. It could have
been either nim-lang.org or nim-lang.github.io, and those reading
the stable docs could have found themselves suddenly reading the
devel docs instead.

* koch.rst: remove link to nonexistent section

* manual.rst: remove unintended link

cast[T](0) is interpreted as a link to id 0 with text T, so escape
the opening parentheses to display the intended output.

* asyncstreams: replace unintended link with emphasis

* Fix word wrapping
2019-10-24 14:07:43 +02:00
..
manual improve documentation for 'var T return values'; refs #7373 2018-04-21 17:01:33 +02:00
advopt.txt first implementation of the new --seqsv2 switch 2019-10-20 08:11:07 +02:00
apis.rst integrate 'koch web' features into koch; deprecate 'nimweb' tool 2018-09-13 18:47:53 +02:00
astspec.txt Prefer relative links for Nim documentation 2019-10-22 17:59:12 -07:00
backends.rst Fix word wrapping 2019-10-22 17:59:12 -07:00
basicopt.txt Fixes #11431 (#11451) [bugfix] 2019-06-10 10:53:34 +02:00
codeowners.rst Fixes #9671 (#9750) 2018-11-19 09:22:21 +01:00
contributing.rst Fix word wrapping 2019-10-22 17:59:12 -07:00
destructors.rst destructors: spec reflects reality, =sink is here to stay 2019-08-11 21:55:47 +02:00
docgen.rst Fix word wrapping 2019-10-22 17:59:12 -07:00
docgen_sample.nim Transforms docgen sample to be generated from source. 2014-01-06 14:55:03 +01: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
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 Fix word wrapping 2019-10-22 17:59:12 -07:00
grammar.txt parser/grammar sync; fixes #9608 [backport] 2018-11-07 20:07:43 +01:00
hcr.rst HCR: better documentation 2019-06-18 12:17:26 +02:00
idetools.rst Fix word wrapping 2019-10-22 17:59:12 -07:00
intern.rst Fix Typos in Internal Docs (#11735) [ci skip] 2019-07-15 19:05:23 +02:00
keywords.txt language change: 'generic' and 'atomic' are not keywords anymore 2017-11-21 11:27:35 +01:00
koch.rst Fix word wrapping 2019-10-22 17:59:12 -07:00
lib.rst Fix many broken links 2019-10-22 17:59:12 -07:00
manual.rst Fix many broken links and prefer relative links within docs (#12463) 2019-10-24 14:07:43 +02:00
manual_experimental.rst Fix word wrapping 2019-10-22 17:59:12 -07: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 Fix word wrapping 2019-10-22 17:59:12 -07:00
nimdoc.css [bugfix] rename Nimrod to Nim, fix #11460 (#11462) 2019-06-10 12:54:43 +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 [other] Documentation NimScript (#11548) 2019-06-23 20:08:21 +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 fix #10287 (#10448) 2019-01-25 08:34:02 +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 Prefer relative links for Nim documentation 2019-10-22 17:59:12 -07:00
tut1.rst Fix word wrapping 2019-10-22 17:59:12 -07:00
tut2.rst [bugfix] Minor formatting fix in tut2 [ci skip] (#11501) 2019-06-14 15:13:44 +02:00
tut3.rst Fix typos. Apply title case. (#11987) 2019-08-21 00:04:01 +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!