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

Use "rst" consistently for code and highlighting directives

Browse Source
This commit is contained in:
Adam Turner 2024-07-14 06:01:47 +01:00
parent f2640a4286
commit 1252c7b549
11 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/extdev/appapi.rst
View File

@ -1,4 +1,4 @@
.. highlight:: rest .. highlight:: rst
Application API Application API
=============== ===============

2
doc/usage/configuration.rst
View File

@ -4054,7 +4054,7 @@ Options for the Python domain
The examples below use the following :rst:dir:`py:function` directive: The examples below use the following :rst:dir:`py:function` directive:
.. code-block:: reStructuredText .. code-block:: rst
.. py:function:: serve_food(item: Literal["egg", "spam", "lobster thermidor"]) -> None .. py:function:: serve_food(item: Literal["egg", "spam", "lobster thermidor"]) -> None

2
doc/usage/extensions/autodoc.rst
View File

@ -1,4 +1,4 @@
.. highlight:: rest .. highlight:: rst
.. _ext-autodoc: .. _ext-autodoc:

2
doc/usage/extensions/autosectionlabel.rst
View File

@ -1,4 +1,4 @@
.. highlight:: rest .. highlight:: rst
:mod:`sphinx.ext.autosectionlabel` -- Allow reference sections using its title :mod:`sphinx.ext.autosectionlabel` -- Allow reference sections using its title
============================================================================== ==============================================================================

2
doc/usage/extensions/autosummary.rst
View File

@ -1,4 +1,4 @@
.. highlight:: rest .. highlight:: rst
:mod:`sphinx.ext.autosummary` -- Generate autodoc summaries :mod:`sphinx.ext.autosummary` -- Generate autodoc summaries
=========================================================== ===========================================================

2
doc/usage/extensions/doctest.rst
View File

@ -1,4 +1,4 @@
.. highlight:: rest .. highlight:: rst
:mod:`sphinx.ext.doctest` -- Test snippets in the documentation :mod:`sphinx.ext.doctest` -- Test snippets in the documentation
=============================================================== ===============================================================

2
doc/usage/extensions/graphviz.rst
View File

@ -1,4 +1,4 @@
.. highlight:: rest .. highlight:: rst
:mod:`sphinx.ext.graphviz` -- Add Graphviz graphs :mod:`sphinx.ext.graphviz` -- Add Graphviz graphs
================================================= =================================================

2
doc/usage/extensions/ifconfig.rst
View File

@ -1,4 +1,4 @@
.. highlight:: rest .. highlight:: rst
:mod:`sphinx.ext.ifconfig` -- Include content based on configuration :mod:`sphinx.ext.ifconfig` -- Include content based on configuration
==================================================================== ====================================================================

2
doc/usage/extensions/inheritance.rst
View File

@ -1,4 +1,4 @@
.. highlight:: rest .. highlight:: rst
:mod:`sphinx.ext.inheritance_diagram` -- Include inheritance diagrams :mod:`sphinx.ext.inheritance_diagram` -- Include inheritance diagrams
===================================================================== =====================================================================

2
doc/usage/extensions/math.rst
View File

@ -1,4 +1,4 @@
.. highlight:: rest .. highlight:: rst
.. _math-support: .. _math-support:

8
doc/usage/restructuredtext/directives.rst
View File

@ -953,7 +953,7 @@ mainly contained in information units, such as the language reference.
(this notation is also used below to describe what entries are created). (this notation is also used below to describe what entries are created).
Examples: Examples:
.. code:: reStructuredText .. code:: rst
.. index:: single: execution .. index:: single: execution
single: execution; context single: execution; context
@ -966,7 +966,7 @@ mainly contained in information units, such as the language reference.
The pair of values must be separated by a semicolon. The pair of values must be separated by a semicolon.
Example: Example:
.. code:: reStructuredText .. code:: rst
.. index:: pair: loop; statement .. index:: pair: loop; statement
@ -976,7 +976,7 @@ mainly contained in information units, such as the language reference.
All three values must be separated by a semicolon. All three values must be separated by a semicolon.
Example: Example:
.. code:: reStructuredText .. code:: rst
.. index:: triple: module; search; path .. index:: triple: module; search; path
@ -986,7 +986,7 @@ mainly contained in information units, such as the language reference.
A shortcut to create an index entry that refers to another entry. A shortcut to create an index entry that refers to another entry.
Example: Example:
.. code:: reStructuredText .. code:: rst
.. index:: see: entry; other .. index:: see: entry; other