| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
* docgen: sort symbols (fix #17910)
* add workaround + change naming
* switch to a dedicated sort comparator
* fix numbers with unequal string lengths
* dedicated `sortName` instead of `plainNameEsc`:
* more compact names for non-overloaded symbols
* more predictable Ascii sort (e.g. `<` instead of `<`)
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* Fix JS error on index page and detect dark mode
The theindex.html page doesn't have a dark mode switch so the main
function will error because `toggleSwitch` is not defined. Checks have
been added to prevent this from happening.
Also add automatic detection of system settings for dark-mode. This
could also be done with pure css, but then the dark mode variable
declarations would have to be duplicated to work with the switch so I
went with this approach.
* Fix nimdoc tests
* Fix rst2html tests
|
| |
|
|
| |
nested templates (#18082)
|
| |
|
|
|
|
|
| |
* fix warnings/hints in nimdoc/tester.nim
* improve err msg for nimdoc/tester.nim and change flag from fixup to nimTestsNimdocFixup
* address comment: put back quit instead of doAssert
|
| |
|
|
|
| |
* `doc2tex`: generate docs to Latex
* address some comments
|
| |
|
|
|
| |
* typo: nonexistant => nonexistent
* fix test (ordering differs because of https://github.com/nim-lang/Nim/issues/17910)
|
| |
|
| |
Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* enable syntax highlighting for inline code
* finish '.. default-role' and preliminary '.. role'
implementation
* more compact check in dirRole
* set :literal: as default role for *.rst
* Update lib/packages/docutils/rst.nim
Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
* use whichRole for setting currRoleKind
* Update lib/packages/docutils/rst.nim
Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
* rename rnGeneralRole -> rnUnknownRole
Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
|
| |
|
|
| |
(#17054)
|
| |
|
|
|
|
|
|
|
| |
top-level runnableExamples in generated docs (#17542)
* fix https://github.com/nim-lang/RFCs/issues/352: show top-level import for top-level runnableExamples in generated docs
* use canonical imoprt
* fix test
|
| |
|
|
|
|
|
| |
(#17416)
* fix #16901: sidebar groups now works with all routines, not just proc,func
* fix tests
|
| | |
|
| | |
|
| |
|
|
|
| |
* both funcs and procs are under the same section in the documentation
* update the test
|
| |
|
|
|
|
|
|
|
| |
The default HTML template for nimdoc currently initializes the dark mode switch and pragma dots when the onload event is fired. But since the onload event does not fire until all external resources (images, stylesheets, fonts, etc.) have been loaded, the light theme is shown for a brief moment before the document is fully loaded, and it switches to the dark theme. This is quite jarring, especially on slower internet connections. So let's instead initialize these things on the DOMContentLoaded event, which is fired right after the document has been parsed and the initial DOM structure is ready. This means that we now display the dark mode immediately, without having to wait for external resources to load first.
For reference, see:
- https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event
- https://developer.mozilla.org/en-US/docs/Web/API/Window/DOMContentLoaded_event
I have updated the snapshot tests in `nimdoc/`, and done some manual testing of both the theme switch and the pragma dots, to confirm that this does not break anything. Please let me know if I've missed anything.
|
| |
|
|
|
| |
* fix #16164, render doc comments
* add a test
|
| | |
|
| | |
|
| | |
|
| |
|
|
|
|
|
| |
* 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
* 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
* Fix tests
Co-authored-by: Clyybber <darkmine956@gmail.com>
|
| |
|
|
|
|
|
|
|
| |
* fix #14846; add macros.extractDocCommentsAndRunnables
* fixup
* update tests
* address comment
|
| |
|
|
|
| |
* fix #14691 docgen methods
* fixup
|
| |
|
|
|
| |
* runnableExamples: correctly handle multiline string litterals
* address comments: improve doc comments + variable namings
|
| | |
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
| |
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
|
| |
|
|
|
|
|
|
|
| |
fixes with nim doc (#14324)
* refs #6583 fix nim doc output
* changelog
* change default for outDir when unspecified
* cleanups
* --project implies --index
|
| |
|
|
| |
* runnableExamples "-b:cpp -r:off": code
|
| | |
|
| | |
|
| |
|
|
|
|
|
|
|
|
| |
* Implement gorgeous Dracula themed Nim documentation
* Add color for escape sequences
* fixes the test cases
* the big CSS cleanup
|
| |
|
|
|
|
| |
* Remove mention of using `discard` for block comments
* Add a 32x32 alternate favicon
|
| |
|
|
|
|
|
|
| |
* renderer letAux fix only for octal literal
* Handle when it's octal -1 for i64
* Added testcases
|
| |
|
|
|
|
|
|
|
|
| |
* 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
* fix the expected html
* clean up the documentation regarding deprecations
* fix typo
* fix system.nim
* fix random
|
| |
|
|
|
|
| |
* Fixes #11078
* Move to existing runnableExamples, update the expected html.
* Remove second comment token.
|
| |
|
|
|
|
| |
* docgen: add links for var, let and const (refs #10487)
* change the expected html
|
| | |
|
| |
|
|
|
|
|
| |
* 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`
|
| |
|
|
|
|
| |
- make documentation usable on small (narrow) screens
- slightly smaller font size in tables
- fix search input width
|
| |
|
|
|
| |
* update documentation CSS
* update the expected htmls
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|