Andrey Makarov
b21eb1ed36
change os.nim doc links to new style ( #19102 )
2021-11-08 13:10:01 +01:00
Andrey Makarov
7ba2659f73
docgen: implement doc link resolution in current module ( #18642 )
2021-10-28 19:20:52 +02:00
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
Andrey Makarov
7e21218a07
follow-up #18013 - inline syntax highlighting ( #18166 )
2021-06-04 16:16:51 +02:00
Andrey Makarov
436af88d8c
follow-up #17837 : add Console for interactive sessions ( #17930 )
...
* follow-up #17837 : add `Console` for interactive sessions
* fix Latex
2021-05-06 10:58:01 +02:00
quantimnot
83ae70cb54
RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) ( #17258 )
...
Co-authored-by: quantimnot <quantimnot@users.noreply.github.com >
2021-03-18 20:37:55 -07:00
flywind
69a78c9183
promote std prefix in docs ( #17128 )
2021-02-20 22:38:29 -08:00
Andrey Makarov
554fe8f88f
conservative approach to fix #15184 ( #16723 )
2021-01-15 00:53:36 +01:00
Elliot Waite
f3d57761ab
Fix broken links in docs ( #16336 )
...
* Fix broken links in docs
* Fix rand HSlice links
2020-12-14 20:13:12 +01:00
Timothee Cour
13b1b19a83
remove all mentions of doc2, jsondoc2 (except 1 mentioning the alias) ( #15683 )
2020-11-26 11:54:18 -08:00
Yanis Zafirópulos
0cae8ef2ca
Massive documentation fixes + copy editing ( #15747 )
2020-10-29 10:33:47 +01:00
Miran
cbd78ec1f6
close #6071 , remove the mentions of deprecated docSeeSrcUrl ( #15350 )
2020-09-17 19:55:18 +02:00
Danil Yarantsev
7936768560
Fix some typos ( #14843 )
2020-06-28 19:17:18 +02:00
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
BinHong Lee
20a59da401
Add --git.devel option to the documentation
2019-12-15 12:45:57 +00:00
Jjp137
3ad48069d3
Fix word wrapping
2019-10-22 17:59:12 -07:00
Jjp137
93461aee34
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.
2019-10-22 17:59:12 -07:00
Tristano Ajmone
8550a8127c
Fix Typos in Internal Docs ( #11735 ) [ci skip]
2019-07-15 19:05:23 +02:00
Federico Ceratto
2cdff617fd
Update docs around docSeeSrcUrl #6071 ( #11074 )
...
Flag docSeeSrcUrl as deprecated.
Add quick start paragraph.
Add links from the language manual.
2019-04-23 11:36:16 +02:00
narimiran
83caa58c7a
docs: fix trailing comma in links
2019-01-25 09:43:47 +01:00
PMunch
db95fad6fa
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.
2018-10-17 00:34:47 +02:00
Araq
4f8cf945fb
docs: remove most stale links; refs #9109
2018-09-29 11:23:29 +02:00
Timothee Cour
baa77387d7
fixes #8215 ; remove reference to old doc command which was deprecated ( #8418 )
2018-08-05 12:15:40 +02:00
Zahary Karadjov
ea36e0ebbe
document the new type[T] and static[T] features
2018-06-16 16:46:32 +03:00
PMunch
5003942256
Renamed jsondoc2 to jsondoc, similar to doc2 ( #7279 )
...
* Update information about jsondoc/jsondoc2
Manual was missing information about jsondoc2 which made it seem like
it didn't exist at all. This commit adds mention of the jsondoc2
command along with an example.
* Renamed jsondoc2 similar to doc2 and updated docs
doc2 was recently renamed to doc while doc was renamed to doc0. This
commits renames jsondoc to jsondoc2 and jsondoc2 to jsondoc0 to behave
tha same way. The documentation for doc/jsondoc was also lagging behind
this change which has also been fixed. I interpreted this as a soft
deprecation of doc and jsondoc and therefore removed them from the
auto-complete lists.
2018-03-08 15:11:45 +01:00
Araq
eed0128916
renamed most remaining .txt documentation files to .rst
2016-06-07 04:04:49 +02:00
