diff options
| author | Renaud <c0bw3b@users.noreply.github.com> | 2022-01-03 16:05:37 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-03 16:05:37 +0100 |
| commit | 3d6fc382d67ebe2584521491f4727fda5fd804ca (patch) | |
| tree | d06b7c29a0bd8adfc372865486364f46b91bce1d /doc | |
| parent | 6d835d9cf59e86749157c9d1936c01007073a077 (diff) | |
| parent | 8583c5f48bb1aea53dcebf76613a1d694d578e69 (diff) | |
| download | nixpkgs-3d6fc382d67ebe2584521491f4727fda5fd804ca.tar nixpkgs-3d6fc382d67ebe2584521491f4727fda5fd804ca.tar.gz nixpkgs-3d6fc382d67ebe2584521491f4727fda5fd804ca.tar.bz2 nixpkgs-3d6fc382d67ebe2584521491f4727fda5fd804ca.tar.lz nixpkgs-3d6fc382d67ebe2584521491f4727fda5fd804ca.tar.xz nixpkgs-3d6fc382d67ebe2584521491f4727fda5fd804ca.tar.zst nixpkgs-3d6fc382d67ebe2584521491f4727fda5fd804ca.zip | |
Merge pull request #152451 from ncfavier/unix-man-urls
doc: remove reference to unix-man-urls.lua
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/build-aux/pandoc-filters/link-unix-man-references.lua | 3 | ||||
| -rw-r--r-- | doc/contributing/contributing-to-documentation.chapter.md | 2 |
2 files changed, 2 insertions, 3 deletions
diff --git a/doc/build-aux/pandoc-filters/link-unix-man-references.lua b/doc/build-aux/pandoc-filters/link-unix-man-references.lua index 12431f140fe..e437ac73a1c 100644 --- a/doc/build-aux/pandoc-filters/link-unix-man-references.lua +++ b/doc/build-aux/pandoc-filters/link-unix-man-references.lua @@ -1,6 +1,5 @@ --[[ -Turns a manpage reference into a link, when a mapping is defined -in the unix-man-urls.lua file. +Turns a manpage reference into a link, when a mapping is defined below. ]] local man_urls = { diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md index 178fdb36262..1384772ebb2 100644 --- a/doc/contributing/contributing-to-documentation.chapter.md +++ b/doc/contributing/contributing-to-documentation.chapter.md @@ -55,7 +55,7 @@ Additionally, the following syntax extensions are currently used: - []{#ssec-contributing-markup-inline-roles} If you want to link to a man page, you can use `` {manpage}`nix.conf(5)` ``, which will turn into {manpage}`nix.conf(5)`. - The references will turn into links when a mapping exists in {file}`doc/build-aux/pandoc-filters/unix-man-urls.lua`. + The references will turn into links when a mapping exists in {file}`doc/build-aux/pandoc-filters/link-unix-man-references.lua`. This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#roles-an-in-line-extension-point). Though, the feature originates from [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-manpage) with slightly different syntax. |