mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-02-15 07:43:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
18,321 Commits 78 Branches 69 Tags
f344a704123a4b55e2b3b8a4f736a6739d0683bb
Commit Graph

55 Commits

Author SHA1 Message Date
Miran
40255f6721 put both funcs and procs under the same section in the documentation (#16301) 
* both funcs and procs are under the same section in the documentation

* update the test
 2020-12-09 10:56:28 +01:00
Sebastian Reinhard
93b6fac468 nimdoc: Initialize theme switch and pragma dots on DOMContentLoaded (#16247) 
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.
 2020-12-06 10:13:19 +01:00
Andrey Makarov
6877e0c8a3 RST tables: fix latex col number; allow less than three of = (#16040) 2020-12-04 08:50:17 +01:00
Miran
c0b76ef3cb fix #16164, render doc comments (#16230) 
* fix #16164, render doc comments

* add a test
 2020-12-02 15:36:08 +01:00
Miran
d0c4c738b9 add a tester for rst2html (#15936) 2020-11-12 22:25:23 +01:00
Miran
bbe49a14ae Correct all eggs (#15906) 
* "eg" is a misspelled "egg", "e.g." is "exempli gratia"
* Also, "ie" is "i.e.".
 2020-11-10 21:53:25 +01:00
Miran
28bbcd9d45 fix #15702, show enum fields documentation (#15792) 2020-10-30 16:30:00 +01:00
Miran
d8a6b0b04e [backport: 1.4] Better linebreaks (#15658) 2020-10-22 12:16:19 +02:00
Timothee Cour
0979524137 add Source+Edit links on top of every docgend file (#15642) 2020-10-22 10:44:28 +02:00
Andreas Rumpf
3b901d1e36 docgen: improve alignment of comments (still not perfect) (#15506) 
* docgen: improve alignment of comments (still not perfect)

* fix error message text in `tunknown_named_parameter`

Co-authored-by: narimiran <narimiran@disroot.org>
 2020-10-07 14:39:13 +02:00
Miran
112b11c154 group procs of the same name in TOC (#15487) 
* 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
 2020-10-05 17:03:14 +02:00
Manuel Bojato
04232d92cd Fix theme switch load from local storage (#14897) 
* fix theme switch load from local storage

* Fix tests

Co-authored-by: Clyybber <darkmine956@gmail.com>
 2020-07-10 15:06:07 +02:00
Timothee Cour
930a0c999b cleanup comment now that #14434 was fixed (#14874) 2020-07-01 14:16:22 -07:00
Timothee Cour
2867a33ebc fix #14846; add macros.extractDocCommentsAndRunnables (#14849) 
* fix #14846; add macros.extractDocCommentsAndRunnables

* fixup

* update tests

* address comment
 2020-07-01 09:26:23 +02:00
Timothee Cour
bb62feff72 fix #14691 docgen works again for methods (#14701) 
* fix #14691 docgen methods

* fixup
 2020-06-18 08:47:16 +02:00
Timothee Cour
0a27cca4b5 runnableExamples: correctly handle multiline string litterals (#14492) 
* runnableExamples: correctly handle multiline string litterals

* address comments: improve doc comments + variable namings
 2020-06-01 15:56:29 +02:00
Timothee Cour
e646c16e06 hotfix doc comments for procs without body (#14494) 2020-05-29 05:30:36 -07:00
Timothee Cour
579456d520 fix #14485 (#14487) 2020-05-28 19:00:36 -07:00
Timothee Cour
e013ebc91a fix #8871 runnableExamples now preserves source code comments, litterals, 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
 2020-05-28 20:46:06 +02:00
Kaushal Modi
e62ccaa4dc Propagate the outDir to rstgen to fix hrefs for modules in subdirs (#14479) 2020-05-28 00:13:24 -07: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
Timothee Cour
3d20f14193 fix #10731 ; runnableExamples "-b:cpp --run:off": code works (#14384) 
* runnableExamples "-b:cpp -r:off": code
 2020-05-20 09:45:34 +02:00
Timothee Cour
7ec7731f82 fix #13150 nim doc --project now works reliably (#13223) 
* 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
 2020-02-06 11:17:00 +01:00
Clyybber
451c47634c Fix docs for subdirs too (#13180) 
* Fix doc subdirs
* Extract to helper proc, and fix on windows
 2020-01-17 16:49:37 +01:00
Clyybber
41cf609fc7 Fix docs (#13176) 2020-01-16 22:22:17 +01:00
Timothee Cour
1b54be7779 fixes #12998 nim doc regression (#13117) 2020-01-16 14:19:58 +01:00
Andreas Rumpf
c282cee4db feature dracula themed doc (#12816) 
* Implement gorgeous Dracula themed Nim documentation

* Add color for escape sequences

* fixes the test cases

* the big CSS cleanup
 2019-12-10 06:48:11 +01:00
Elliot Waite
5da27a891c Removing the mention of using discard for block comments (#12837) [backport] 
* Remove mention of using `discard` for block comments

* Add a 32x32 alternate favicon
 2019-12-08 20:16:17 +01:00
Ridho Pratama
7ef4bffa79 renderer letAux fix only for octal literal (#12343) 
* renderer letAux fix only for octal literal

* Handle when it's octal -1 for i64

* Added testcases
 2019-10-08 11:12:24 +02:00
Andreas Rumpf
3d88d06b32 better run [feature] (#11709) 
* 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
 2019-07-11 21:36:23 +02:00
Hugo Locurcio
0a1cb631a2 Implement some custom formatting for input fields in the documentation (#11632) 
* 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
 2019-07-03 07:40:24 +02:00
LemonBoy
7d217a71d3 Render deprecated pragmas (#8886) 
* Render deprecated pragmas
* fix the expected html
* clean up the documentation regarding deprecations
* fix typo
* fix system.nim
* fix random
 2019-06-03 10:15:20 +02:00
Kaushal Modi
2f610d621f Use the correct HTML file reference in "nim doc" generated idx files (#11326) 
* 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
 2019-05-25 20:20:25 +02:00
Jasper Jenkins
e64dde734b Fixes #11078 (#11079) 
* Fixes #11078
* Move to existing runnableExamples, update the expected html.
* Remove second comment token.
 2019-04-23 14:20:27 +02:00
Miran
54151ce398 docgen: add links for var, let and const (refs #10487) (#10868) 
* docgen: add links for var, let and const (refs #10487)

* change the expected html
 2019-03-20 11:23:38 +01:00
Anthon van der Neut
5c1c5902e2 fixes #10857 invisible span had width (#10860) 2019-03-19 10:38:48 +01:00
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