summary refs log tree commit diff stats
path: root/nimdoc
Commit message (Collapse)AuthorAgeFilesLines
* docgen: improve alignment of comments (still not perfect) (#15506)Andreas Rumpf2020-10-071-5/+6
| | | | | | | * docgen: improve alignment of comments (still not perfect) * fix error message text in `tunknown_named_parameter` Co-authored-by: narimiran <narimiran@disroot.org>
* group procs of the same name in TOC (#15487)Miran2020-10-053-61/+157
| | | | | | | | | | | * group procs of the same name in TOC * correctly show `sink` parameters in TOC * no need to reinvent the wheel - `mgetorPut` exists * better setting of text color [ci skip] * fix CSS for better alignment
* Fix theme switch load from local storage (#14897)Manuel Bojato2020-07-105-70/+25
| | | | | | | * fix theme switch load from local storage * Fix tests Co-authored-by: Clyybber <darkmine956@gmail.com>
* cleanup comment now that #14434 was fixed (#14874)Timothee Cour2020-07-011-2/+0
|
* fix #14846; add macros.extractDocCommentsAndRunnables (#14849)Timothee Cour2020-07-014-0/+58
| | | | | | | | | * fix #14846; add macros.extractDocCommentsAndRunnables * fixup * update tests * address comment
* fix #14691 docgen works again for methods (#14701)Timothee Cour2020-06-184-0/+105
| | | | | * fix #14691 docgen methods * fixup
* runnableExamples: correctly handle multiline string litterals (#14492)Timothee Cour2020-06-014-0/+90
| | | | | * runnableExamples: correctly handle multiline string litterals * address comments: improve doc comments + variable namings
* hotfix doc comments for procs without body (#14494)Timothee Cour2020-05-294-0/+98
|
* fix #14485 (#14487)Timothee Cour2020-05-284-0/+42
|
* fix #8871 runnableExamples now preserves source code comments, litterals, ↵Timothee Cour2020-05-288-19/+722
| | | | | | | | | | | and all formatting; other bug fix (#14439) * fix #8871 runnableExamples now preserves source code comments, litterals, and all formatting * remove orig deadcode from getAllRunnableExamplesImpl * fix expected examples * add test to close https://github.com/nim-lang/Nim/issues/14473 * correctly handle regular comments before 1st token inside runnableExamples * add test to answer https://github.com/nim-lang/Nim/pull/14439#discussion_r431829199 * update tests
* Propagate the outDir to rstgen to fix hrefs for modules in subdirs (#14479)Kaushal Modi2020-05-283-1/+27
|
* fix #6583, fix #14376, index+search now generated for all projects, many bug ↵Timothee Cour2020-05-253-1/+10
| | | | | | | | | fixes with nim doc (#14324) * refs #6583 fix nim doc output * changelog * change default for outDir when unspecified * cleanups * --project implies --index
* fix #10731 ; `runnableExamples "-b:cpp --run:off": code` works (#14384)Timothee Cour2020-05-202-3/+4
| | | | * runnableExamples "-b:cpp -r:off": code
* fix #13150 `nim doc --project` now works reliably (#13223)Timothee Cour2020-02-061-2/+2
| | | | | | | | | | * fix #13150 `nim doc --project` works with duplicate names and with imports below main project file * add to help; fixup after #13212 isRelativeTo got merged * fix test tests/compilerapi/tcompilerapi.nim * remove nimblePkg field; compute on the fly instead * kochdocs: compiler docs now under compiler/ * --docRoot now has smart default: best among @pkg, @path
* Fix docs for subdirs too (#13180)Clyybber2020-01-171-1/+1
| | | | | * Fix doc subdirs * Extract to helper proc, and fix on windows
* Fix docs (#13176)Clyybber2020-01-165-5/+5
|
* fixes #12998 nim doc regression (#13117)Timothee Cour2020-01-165-5/+5
|
* feature dracula themed doc (#12816)Andreas Rumpf2019-12-105-3835/+186
| | | | | | | | | | * Implement gorgeous Dracula themed Nim documentation * Add color for escape sequences * fixes the test cases * the big CSS cleanup
* Removing the mention of using `discard` for block comments (#12837) [backport]Elliot Waite2019-12-085-0/+5
| | | | | | * Remove mention of using `discard` for block comments * Add a 32x32 alternate favicon
* renderer letAux fix only for octal literal (#12343)Ridho Pratama2019-10-083-1/+69
| | | | | | | | * renderer letAux fix only for octal literal * Handle when it's octal -1 for i64 * Added testcases
* better run [feature] (#11709)Andreas Rumpf2019-07-111-4/+6
| | | | | | | * track the checksums of all involved Nim files for smarter 'nim c -r' recompiles * don't recompile unless necessary for 'nim c -r' [feature] * [feature] koch boot uses a two step process in order to free the RAM before the GCC/Clang invocations * fixes a serious regression
* Implement some custom formatting for input fields in the documentation (#11632)Hugo Locurcio2019-07-035-0/+85
| | | | | | | | | | * Implement some custom formatting for input fields in the documentation Aside of resulting in more consistent appearance across browsers, this also fixes input form rendering when using Firefox with a dark system theme on Linux. * change the expected html in the tests
* Render deprecated pragmas (#8886)LemonBoy2019-06-035-0/+56
| | | | | | | | | * Render deprecated pragmas * fix the expected html * clean up the documentation regarding deprecations * fix typo * fix system.nim * fix random
* Use the correct HTML file reference in "nim doc" generated idx files (#11326)Kaushal Modi2019-05-255-10/+1715
| | | | | | | | | | | | | | | | | | | * Use the correct HTML file reference in "nim doc" generated idx files Now "nim doc --out:foo.html --index:on bar.nim" generates "foo.html" and the generated "bar.idx" contains references to "foo.html". Fixes https://github.com/nim-lang/Nim/issues/11325. * Refactor the nim doc tester to extend it for more tests * Reference the HTML files relative to the outDir, not project dir * Add test for issues #11312 and #11325 - https://github.com/nim-lang/Nim/issues/11312 - https://github.com/nim-lang/Nim/issues/11325
* Fixes #11078 (#11079)Jasper Jenkins2019-04-232-1/+5
| | | | | | * Fixes #11078 * Move to existing runnableExamples, update the expected html. * Remove second comment token.
* docgen: add links for var, let and const (refs #10487) (#10868)Miran2019-03-201-1/+1
| | | | | | * docgen: add links for var, let and const (refs #10487) * change the expected html
* fixes #10857 invisible span had width (#10860)Anthon van der Neut2019-03-193-12/+24
|
* documentation style tweaks (#10790)Miran2019-03-083-9/+9
| | | | | | | * 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`
* fix documentation CSSnarimiran2019-02-053-48/+84
| | | | | | - make documentation usable on small (narrow) screens - slightly smaller font size in tables - fix search input width
* update documentation CSS (#10543)Miran2019-02-043-2028/+693
| | | | | * update documentation CSS * update the expected htmls
* change the expected output of nim docnarimiran2019-01-283-15/+6
|
* docgen: do not produce trailing commas for linksAraq2019-01-253-20/+20
|
* docgen: produce links for proc namesAraq2019-01-253-9/+10
|
* RST parser: fixes #8158Araq2019-01-112-1/+17
|
* docgen: support markdown headings tooAraq2019-01-113-3/+26
|
* docgen: support markdown link syntax; enable markdown extensionsAraq2019-01-113-2/+4
|
* Change documentation details (closes #5525) (#9542)Miran2018-10-312-4/+4
|
* docgen: fixes #9432 [backport]Araq2018-10-315-1/+132
|
* Do not encode the anchors in docs (`id` attr in `a` tags) (#9261)Kaushal Modi2018-10-092-4/+4
| | | | | Update the tests too. Fixes https://github.com/nim-lang/Nim/issues/9232.
* Make "koch docs" copy the dochack.js to the right location tooKaushal Modi2018-09-293-3/+3
| | | | | | | | | | - 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.
* Don't prevent ',' from getting escaped in theindex.htmlKaushal Modi2018-09-281-4/+4
| | | | | | - 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.
* Encode non-alphanum chars like %, + in URLs in the docsKaushal Modi2018-09-282-10/+16
| | | | | | | | | | | | | 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.
* Revert #7964LemonBoy2018-09-213-1/+25
| | | | | | | Somehow the test case doesn't crash anymore and the regression in the doc generation is fixed. Fixes #9019
* make documentation generator tests green againAraq2018-09-133-5/+10
|
* index generation for docgen knows about subdirectories; index knows about ↵Araq2018-09-134-3/+1276
| | | | enum values; fixes import statement for runnableExamples
* added a test for 'nim doc'Andreas Rumpf2018-09-076-0/+2687