IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Improve mark-up in docs (follow-up to PR #10366)

Browse Source
This commit is contained in:
jfbu 2022-06-26 09:30:22 +02:00
parent d4aba4b935
commit 8ecbe8a15a
3 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -17,7 +17,8 @@ Features added
--------------
* #10366: std domain: Add support for emphasising placeholders in :rst:dir:`option`
directives through a new ``option_emphasise_placeholders`` configuration option.
directives through a new :confval:`option_emphasise_placeholders` configuration
option.
* #10439: std domain: Use the repr of some variables when displaying warnings,
making whitespace issues easier to identify.
* #10571: quickstart: Reduce content in the generated ``conf.py`` file. Patch by

2
doc/usage/configuration.rst
View File

@ -709,7 +709,7 @@ General configuration
.. confval:: option_emphasise_placeholders
Default is ``False``.
When enabled, emphasise placeholders in ``.. option:`` directives.
When enabled, emphasise placeholders in :rst:dir:`option` directives.
To display literal braces, escape with a backslash (``\{``). For example,
``option_emphasise_placeholders=True`` and ``.. option:: -foption={TYPE}`` would
render with ``TYPE`` emphasised.

2
doc/usage/restructuredtext/domains.rst
View File

@ -1751,7 +1751,7 @@ There is a set of directives allowing documenting command-line programs:
like ``:option:`dest_dir```, ``:option:`-m```, or ``:option:`--module```).
Use :confval:`option_emphasise_placeholders` for parsing of
"variable part" of a literal text (similarly to the ``samp`` role).
"variable part" of a literal text (similarly to the :rst:role:`samp` role).
``cmdoption`` directive is a deprecated alias for the ``option`` directive.