extend option directive syntax

One can cross-reference an option value: :option:`--module=foobar`.
This commit is contained in:
Martin Liska authored and Adam Turner committed 2022-09-27 19:02:45 +01:00
1 parent 05683f794c
commit 29e6adab12
5 files changed
+36 -1

No files matched your search

+4
View File
@@ -1775,6 +1775,10 @@ There is a set of directives allowing documenting command-line programs:
referenceable by :rst:role:`option` (in the example case, you'd use something
like ``:option:`dest_dir```, ``:option:`-m```, or ``:option:`--module```).
.. versionchanged:: 5.3
One can cross-reference including an option value: ``:option:`--module=foobar```.
Use :confval:`option_emphasise_placeholders` for parsing of
"variable part" of a literal text (similarly to the :rst:role:`samp` role).