diff options
| author | Jan Tojnar <jtojnar@gmail.com> | 2021-07-12 04:44:46 +0200 |
|---|---|---|
| committer | Jan Tojnar <jtojnar@gmail.com> | 2021-07-12 22:57:29 +0200 |
| commit | df55fbb62aea05fa3e48c4f7c2021bba49485ed5 (patch) | |
| tree | 0267e08e9979335f5a6b365ffc160e81ab60551a | |
| parent | a49d36b979104205d016bb67d5ad6391df43e9ed (diff) | |
| download | nixpkgs-df55fbb62aea05fa3e48c4f7c2021bba49485ed5.tar nixpkgs-df55fbb62aea05fa3e48c4f7c2021bba49485ed5.tar.gz nixpkgs-df55fbb62aea05fa3e48c4f7c2021bba49485ed5.tar.bz2 nixpkgs-df55fbb62aea05fa3e48c4f7c2021bba49485ed5.tar.lz nixpkgs-df55fbb62aea05fa3e48c4f7c2021bba49485ed5.tar.xz nixpkgs-df55fbb62aea05fa3e48c4f7c2021bba49485ed5.tar.zst nixpkgs-df55fbb62aea05fa3e48c4f7c2021bba49485ed5.zip | |
doc: comment lua scripts
| -rw-r--r-- | doc/build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua b/doc/build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua index 67569b02091..fa97729a28b 100644 --- a/doc/build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua +++ b/doc/build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua @@ -1,3 +1,13 @@ +--[[ +Converts Link AST nodes with empty label to DocBook xref elements. + +This is a temporary script to be able use cross-references conveniently +using syntax taken from MyST, while we still use docbook-xsl +for generating the documentation. + +Reference: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing +]] + local function starts_with(start, str) return str:sub(1, #start) == start end |