3
0
Fork 0
forked from mirrors/nixpkgs
Commit graph

11 commits

Author SHA1 Message Date
pennae 798b7fdc5c doc/filters: fix myst-reader role detection
matching on only `{...}` does not trigger if the role tag is preceded by
something usually considered a semantic separator that isn't a separator
as markdown knows it, e.g. punctuation characters.
2023-01-10 10:31:51 +01:00
Naïm Favier a8d4cf149c
doc: separate manpage URLs from the Pandoc filter
Move the manpage-to-URL mapping to `doc/manpage-urls.json` so that we can
reuse that file elsewhere, and generate the `link-manpages.lua` filter from
that file.

Also modify the Pandoc filter so that it doesn't wrap manpages that are
already inside a link.

Keeping a Lua filter is essential for speed: a Python filter would
increase the runtime `md-to-db.sh` from ~20s to ~30s (but Python is not
to blame; marshalling Pandoc types to and from JSON is a costly operation).
Parsing in Lua seems tedious, so I went with the Nix way.
2023-01-02 14:11:22 +01:00
Naïm Favier feb9ba5839
doc/link-unix-man-references: add a bunch of systemd pages 2022-12-22 16:03:31 +01:00
Jan Tojnar fa285355ee nixos/doc/manual/md-to-db.sh: Add support for <kbd> element 2022-10-26 01:46:44 +02:00
pennae 9c3c13b50d nixos/make-options-doc: add inline roles for varname/envar
both of these render distinctly from plain literals in the manpage, and
manpages even semantically distinguish between the two.
2022-08-31 16:21:10 +02:00
pennae 320aa2a791 treewide: attempt at markdown option docs 2022-06-12 12:44:38 +02:00
Naïm Favier 8583c5f48b
doc: remove reference to unix-man-urls.lua 2021-12-28 13:26:35 +01:00
Jan Tojnar 04b59b0328 doc: Linkify man page references 2021-07-13 02:21:22 +02:00
Jan Tojnar c9139dfa1a doc: Add support for MyST roles
Officially, only the manpage role is supported at the moment.

Unlike in rST, the syntax uses braces instead of colons:

    {manpage}`nix.conf(5)`
2021-07-13 02:10:57 +02:00
Jan Tojnar df55fbb62a doc: comment lua scripts 2021-07-12 22:57:29 +02:00
Jan Tojnar a49d36b979 doc: Move lua filters to subdirectory 2021-07-12 22:57:28 +02:00