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

Minor cross-linking improvements in usage/restructuredtext/roles.rst

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

6
doc/usage/restructuredtext/roles.rst
View File

@ -292,8 +292,8 @@ Inline code highlighting
Unlike the :rst:dir:`code-block` directive, this role does not respect the Unlike the :rst:dir:`code-block` directive, this role does not respect the
default language set by the :rst:dir:`highlight` directive. default language set by the :rst:dir:`highlight` directive.
To enable syntax highlighting, you must first use the ``role`` directive to To enable syntax highlighting, you must first use the Docutils :dudir:`role`
define a custom ``code`` role for a particular language: directive to define a custom role associated with a specific language:
.. code-block:: rst .. code-block:: rst
@ -446,7 +446,7 @@ different style:
emphasized. emphasized.
If you don't need the "variable part" indication, use the standard If you don't need the "variable part" indication, use the standard
````code```` instead. :rst:role:`code` role instead.
.. versionchanged:: 1.8 .. versionchanged:: 1.8
Allowed to escape curly braces with backslash Allowed to escape curly braces with backslash