about summary refs log tree commit diff
path: root/doc/build-aux
AgeCommit message (Collapse)AuthorFilesLines
2023-07-01doc: remove remnants of docbook timespennae6-190/+0
all xml-related tooling can go away. shell.nix is no longer useful since the makefile is gone and the build runs entirely via a derivation, and gitignore is thus also no longer that useful. it may filter out some swap files, but its main reason to exist (keeping generated files out of a concurrent build of the derivation) has gone away.
2023-05-06treewide: switch builtins.fromJSON(builtins.readFile ./file.json) to ↵Sandro Jäckel1-1/+1
lib.importJSON ./file.json #2
2023-02-10nixos/manual: remove md-to-dbpennae1-11/+0
with manual chapters no longer needing pandoc for their conversion to xml we can get rid of this source of confusion, and its huge cache of xml files.
2023-02-10nixos/manual: convert <kbd> elements to bracketed spanspennae1-5/+5
since support for kbd elements was added with explicit intent in #175128 it seems like a good idea to support this in nixos-render-docs instead of just dropping it in favor of `*F12*` etc. since it's a very rare thing in the manual and purely presentational it makes sense to use bracketed spans instead of a new myst role. the html-elements.lua plugin is now somewhat misnamed, but it'll go away very soon so we don't want to bother renaming it.
2023-01-10doc/filters: fix myst-reader role detectionpennae1-3/+10
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-02doc: separate manpage URLs from the Pandoc filterNaïm Favier2-38/+28
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.
2022-12-22doc/link-unix-man-references: add a bunch of systemd pagesNaïm Favier1-2/+23
2022-10-26nixos/doc/manual/md-to-db.sh: Add support for <kbd> elementJan Tojnar1-0/+11
2022-08-31nixos/make-options-doc: add inline roles for varname/envarpennae1-0/+4
both of these render distinctly from plain literals in the manpage, and manpages even semantically distinguish between the two.
2022-06-12treewide: attempt at markdown option docspennae1-0/+4
2021-12-28doc: remove reference to unix-man-urls.luaNaïm Favier1-2/+1
2021-07-13doc: Linkify man page referencesJan Tojnar1-0/+18
2021-07-13doc: Add support for MyST rolesJan Tojnar4-0/+113
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-12doc: comment lua scriptsJan Tojnar1-0/+10
2021-07-12doc: Move lua filters to subdirectoryJan Tojnar1-0/+24