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

sphinx-doc · Jun 26, 2022 · 8ecbe8a · 8ecbe8a
1 parent d4aba4b
commit 8ecbe8a
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/CHANGES b/CHANGES
@@ -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

diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst
@@ -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.

diff --git a/doc/usage/restructuredtext/domains.rst b/doc/usage/restructuredtext/domains.rst
@@ -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.