Commit graph

67 commits

Author SHA1 Message Date
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
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
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
a0fb77dfd5 add links to every document, fixes #5515 2019-02-16 18:26:28 +00: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
96a8caa9ef fix documentation css 2019-01-28 10:58: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
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
Timothee Cour
c0f78ec012 fixes #8419 fixes #8420 ; workaround #6071 workaround nim-lang/website#98 (#8423)
add --git.devel option to override doc generated "edit" links; add --nimCompiler option to nimweb
2018-07-30 14:02:18 +02:00
Quelklef
f2b6efb7dc Make pragmas look clickable in docs (#8176)
* Visual cues for hidden pragmas in docs.
* Add hover cue
2018-07-17 12:14:31 +02:00
Simon Krauter
952084eeef
Fix background-color in nimdoc.cfg
Don't assume, that the default background-color is white.
My default background-color is dark, which makes the documentation hardly readable: https://i.imgur.com/xN0UjWz.png
The reason is the transparency of the existing color (rgba(252, 248, 244, 0.45);) 
Fixed by removing the transparency.
2018-03-11 18:23:31 +01:00
Araq
a9974a33f1 more documentation fixes 2018-03-05 23:25:50 +01:00
Andreas Rumpf
1b760dcd66 fixes #5293 2018-03-05 19:46:13 +01:00
Araq
8572085cc7 fixes #7294; Nim doc search feature 2018-03-05 13:20:50 +01:00
Federico Ceratto
5fdc69dfbd Update docgen style (#6723)
Switch to Lato font for better readability
Make text darker
Make spacing between paragraph and pre block consistent
Fix search input box to prevent overlapping with text
2017-11-29 01:35:26 +01:00
Araq
d6d40a2d3c fixes the docgen configuration; refs #6780 2017-11-28 01:57:44 +01:00
Federico Ceratto
821a6ef4c2 Add links to documentation (#6780)
Related to #4219
2017-11-27 05:41:55 -05:00
Konstantin Molchanov
20f92616d2 Add meta tag to ensure that media queries are activated on mobile devices. 2017-04-20 11:06:59 +04:00
Andreas Rumpf
e8389dcb93 docgen: make whitespace around 'class=' more consistent 2017-04-12 15:05:28 +02:00
Zion
04ebe7be51 Make fonts load from https rather than http 2017-03-27 23:55:51 -07:00
Araq
42b64e3257 minor CSS improvement 2016-10-01 00:02:34 +02:00
Araq
3dfc866710 docgen: working search feature 2016-09-09 20:42:02 +02:00
Andreas Rumpf
0a2cc05541 docgen: minor changes 2016-09-09 16:55:20 +02:00
Andreas Rumpf
7621bb05c9 docgen: search feature 2016-09-09 16:25:09 +02:00
Araq
37c3c0033d generated theindex.html is valid html 2016-09-09 16:16:58 +02:00
Andreas Rumpf
083b31b473 docgen: group by type feature 2016-09-08 21:57:27 +02:00
Andreas Rumpf
07fcce6e63 docgen: different attachedType generation 2016-09-08 21:57:27 +02:00
Andreas Rumpf
dc8ec42969 documentation now has an 'edit' button 2016-09-08 15:06:27 +02:00
Andreas Rumpf
abf1951ff0 docgen: hide pragmas 2016-07-08 15:08:55 +02:00
Felix Krause
708b9f90b7 Made docgen emit valid XML by default 2016-01-11 22:52:59 +01:00
Dominik Picheta
dfa0c2cace Change nimdoc body css color to #666. 2015-09-17 22:49:53 +01:00
Araq
f7bdc205c7 documentation generator emits configurable html for code listings 2015-07-14 01:37:09 +02:00
Varriount
9da1ee4fe4 Add NEP1 to documentation.
Changes:
  - Added NEP 1 to the documentation set.
  - Modified nimdoc's css to add additional spacing between list entries, as well as between code blocks.
  - Added a warning to nimdoc.css for future developers.
2015-07-10 03:51:00 -04:00
Federico Ceratto
657dca5c3b Fix typos 2015-02-15 16:20:32 +00:00
def
b866d9e5e6 Improve documentation CSS for smaller resolutions 2015-01-11 04:37:04 +01:00
Flaviu Tamas
f9c93d23bc Mostly get analytics working for docs 2014-12-25 20:53:37 -05:00
Nick Greenfield
eba4b4008d Fix paragraph break issue in nimc.txt. Add spacing to command line options table. 2014-12-21 18:49:39 -05:00
Nick Greenfield
e6abd673b8 Fix blockquotes in documentation; stylize only in docinfo or immediately after an h1 2014-12-21 18:22:20 -05:00
Araq
2990a9224b better CSS; better docs for teh tables module 2014-12-21 15:59:01 +01:00
Nick Greenfield
fb93cee95d Improved nimdoc styling.
This updates the inlined CSS in nimdoc.cfg, adds several helper classes
(and a few divs) to the generated HTML (some in nimdoc.cfg, one in
rstgen.nim), and tweaks the anchor linking scheme for headers in
rstgen.nim.
2014-12-19 21:08:11 -05:00
Araq
4aab018bd6 disable 'view source' feature 2014-10-20 01:05:13 +02:00
Simon Krauter
6043194465 Fixed missing color definion in docs CSS 2014-10-14 23:32:28 +02:00