From 851bc1b6dbd5e683712d573121538b233048d759 Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Sun, 27 Sep 2026 11:44:11 +0200 Subject: [PATCH 1/3] doc/readme: Clarify variable literals --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 14de0dd2651b..287e0a0bf60f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -133,7 +133,7 @@ A few markups for other kinds of literals are also available: - `` {env}`XDG_DATA_DIRS` `` - `` {file}`/etc/passwd` `` - `` {option}`networking.useDHCP` `` -- `` {var}`/etc/passwd` `` +- `` {var}`pkgs` `` These literal kinds are used mostly in NixOS option documentation. From 29fb5377de973dae5beca1e5ed2927e48335eac5 Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Sun, 27 Sep 2026 11:45:17 +0200 Subject: [PATCH 2/3] doc/readme: Explain how literals are formatted --- doc/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/README.md b/doc/README.md index 287e0a0bf60f..cc83c9e2012f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -135,6 +135,8 @@ A few markups for other kinds of literals are also available: - `` {option}`networking.useDHCP` `` - `` {var}`pkgs` `` +The values will be formatted as inline `` elements. + These literal kinds are used mostly in NixOS option documentation. This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#roles-an-in-line-extension-point). From 2754e18b476b06882f4a837ad71e4e4380b691e8 Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Sun, 27 Sep 2026 11:46:19 +0200 Subject: [PATCH 3/3] doc/readme: Remove paragraph about the inspiration for literals --- doc/README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/doc/README.md b/doc/README.md index cc83c9e2012f..2897a2d26aa8 100644 --- a/doc/README.md +++ b/doc/README.md @@ -139,10 +139,6 @@ The values will be formatted as inline `` elements. These literal kinds are used mostly in NixOS option documentation. -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. -They are handled by `myst_role` defined per renderer. - #### Admonitions Set off from the text to bring attention to something.