Use "rst" consistently for code and highlighting directives

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

View File

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

View File

@ -4054,7 +4054,7 @@ Options for the Python domain
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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

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).
Examples:
.. code:: reStructuredText
.. code:: rst
.. index:: single: execution
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.
Example:
.. code:: reStructuredText
.. code:: rst
.. 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.
Example:
.. code:: reStructuredText
.. code:: rst
.. 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.
Example:
.. code:: reStructuredText
.. code:: rst
.. index:: see: entry; other