mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
extend option directive syntax
One can cross-reference an option value: :option:`--module=foobar`.
This commit is contained in:
committed by
Adam Turner
parent
05683f794c
commit
29e6adab12
@@ -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).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user