Miran
bba3a20e7c
documentation style tweaks ( #10790 )
...
* exports are the least important field in the docs:
they are put in the last place (at the bottom)
* indent text after proc/type declaration for an easier navigation
(noticeable difference between declarations and examples)
* quickfix invalid style in `asynchttpserver`
2019-03-08 13:55:26 +01:00
narimiran
21b256dbc9
fix documentation CSS
...
- make documentation usable on small (narrow) screens
- slightly smaller font size in tables
- fix search input width
2019-02-05 14:01:47 +01:00
Miran
8cb80238c4
update documentation CSS ( #10543 )
...
* update documentation CSS
* update the expected htmls
2019-02-04 12:27:02 +01:00
narimiran
ee8bc96a89
change the expected output of nim doc
2019-01-28 16:59:07 +01:00
Araq
3de255541a
docgen: do not produce trailing commas for links
2019-01-25 09:21:51 +01:00
Araq
13d667ee53
docgen: produce links for proc names
2019-01-25 09:21:51 +01:00
Araq
56b804a283
RST parser: fixes #8158
2019-01-11 22:17:43 +01:00
Araq
ee7f2d97cc
docgen: support markdown headings too
2019-01-11 22:17:43 +01:00
Araq
5ef5dc86c5
docgen: support markdown link syntax; enable markdown extensions
2019-01-11 22:17:43 +01:00
Miran
313bbf5b9b
Change documentation details ( closes #5525 ) ( #9542 )
2018-10-31 07:40:05 +01:00
Araq
48f73aaa1c
docgen: fixes #9432 [backport]
2018-10-31 00:19:24 +01:00
Kaushal Modi
c6dfbfc2cf
Do not encode the anchors in docs (id attr in a tags) ( #9261 )
...
Update the tests too.
Fixes https://github.com/nim-lang/Nim/issues/9232 .
2018-10-09 20:48:00 +02:00
Kaushal Modi
2e5c759736
Make "koch docs" copy the dochack.js to the right location too
...
- Fixes https://github.com/nim-lang/Nim/issues/9104 .
- Fixes https://github.com/nim-lang/Nim/issues/9095 .
Expect dochack.js to be fetched from the doc/html/ dir instead of from
doc/.
Also remove an unused and unexported proc pathPart.
2018-09-29 13:15:29 -04:00
Kaushal Modi
903886396d
Don't prevent ',' from getting escaped in theindex.html
...
- Enable escaping of links in theindex.html
- Fixes https://github.com/nim-lang/Nim/issues/9107 .
- Second part of the fix for https://github.com/nim-lang/Nim/issues/9097 .
2018-09-28 15:39:22 -04:00
Kaushal Modi
de8cb0a1cf
Encode non-alphanum chars like %, + in URLs in the docs
...
Use $itemSymOrIDEnc instead of $itemSymOrID in the id and href attr in
a tags.
Fixes https://github.com/nim-lang/Nim/issues/9097 .
Thanks to @LemonBoy for helping with this commit.
---
Update the tests too -- "nim c -r nimdoc/tester" passes.
2018-09-28 13:52:54 -04:00
LemonBoy
4d9aec1858
Revert #7964
...
Somehow the test case doesn't crash anymore and the regression in the
doc generation is fixed.
Fixes #9019
2018-09-21 18:59:46 +02:00
Araq
9b29436f62
make documentation generator tests green again
2018-09-13 23:18:51 +02:00
Araq
b9ed684dd2
index generation for docgen knows about subdirectories; index knows about enum values; fixes import statement for runnableExamples
2018-09-13 01:05:51 +02:00
Andreas Rumpf
b017138c32
added a test for 'nim doc'
2018-09-07 19:21:16 +02:00
