summary refs log tree commit diff
path: root/doc/contributing/contributing-to-documentation.chapter.md
diff options
context:
space:
mode:
authorJan Tojnar <jtojnar@gmail.com>2021-07-12 15:54:14 +0200
committerJan Tojnar <jtojnar@gmail.com>2021-07-13 02:10:57 +0200
commitc9139dfa1a001e32baa6fea9c9373d80c83e39e9 (patch)
treea55bbcb0aa06d5568f4682533846d9a23d48e46f /doc/contributing/contributing-to-documentation.chapter.md
parentdf55fbb62aea05fa3e48c4f7c2021bba49485ed5 (diff)
downloadnixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar
nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar.gz
nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar.bz2
nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar.lz
nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar.xz
nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.tar.zst
nixpkgs-c9139dfa1a001e32baa6fea9c9373d80c83e39e9.zip
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)`
Diffstat (limited to 'doc/contributing/contributing-to-documentation.chapter.md')
-rw-r--r--doc/contributing/contributing-to-documentation.chapter.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md
index 2f7ae32259c..bf73a340bce 100644
--- a/doc/contributing/contributing-to-documentation.chapter.md
+++ b/doc/contributing/contributing-to-documentation.chapter.md
@@ -52,6 +52,11 @@ Additionally, the following syntax extensions are currently used:
 
   This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing).
 
+- []{#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)`.
+
+  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.
+
 - []{#ssec-contributing-markup-admonitions}
   **Admonitions**, set off from the text to bring attention to something.