Standardise on a common directive for describing code snippets

This commit is contained in:
Adam Turner 2024-07-14 06:06:07 +01:00
parent 1252c7b549
commit 7b570c06a1
7 changed files with 13 additions and 12 deletions

View File

@ -114,7 +114,7 @@ Theme configuration (``theme.conf``)
The :file:`theme.conf` file is in INI format [1]_ (readable by the standard The :file:`theme.conf` file is in INI format [1]_ (readable by the standard
Python :mod:`configparser` module) and has the following structure: Python :mod:`configparser` module) and has the following structure:
.. sourcecode:: ini .. code-block:: ini
[theme] [theme]
inherit = base theme inherit = base theme

View File

@ -429,14 +429,14 @@ Keys that don't need to be overridden unless in special cases are:
``'geometry'`` ``'geometry'``
"geometry" package inclusion, the default definition is: "geometry" package inclusion, the default definition is:
.. code:: latex .. code-block:: latex
'\\usepackage{geometry}' '\\usepackage{geometry}'
with an additional ``[dvipdfm]`` for Japanese documents. with an additional ``[dvipdfm]`` for Japanese documents.
The Sphinx LaTeX style file executes: The Sphinx LaTeX style file executes:
.. code:: latex .. code-block:: latex
\PassOptionsToPackage{hmargin=1in,vmargin=1in,marginpar=0.5in}{geometry} \PassOptionsToPackage{hmargin=1in,vmargin=1in,marginpar=0.5in}{geometry}

View File

@ -123,7 +123,7 @@ This is particularly useful for literate programming:
.. py:function:: spam(eggs) .. py:function:: spam(eggs)
:no-typesetting: :no-typesetting:
.. code:: .. code:: python
def spam(eggs): def spam(eggs):
pass pass

View File

@ -545,7 +545,7 @@ It is customary to put the opening bracket before the comma.
Python 3.12 introduced *type parameters*, which are type variables Python 3.12 introduced *type parameters*, which are type variables
declared directly within the class or function definition: declared directly within the class or function definition:
.. code:: python .. code-block:: python
class AnimalList[AnimalT](list[AnimalT]): class AnimalList[AnimalT](list[AnimalT]):
... ...
@ -555,7 +555,7 @@ declared directly within the class or function definition:
The corresponding reStructuredText documentation would be: The corresponding reStructuredText documentation would be:
.. code:: rst .. code-block:: rst
.. py:class:: AnimalList[AnimalT] .. py:class:: AnimalList[AnimalT]

View File

@ -145,7 +145,7 @@ linking:
Example: Example:
.. code:: python .. code-block:: python
intersphinx_mapping = {'https://docs.python.org/': None} intersphinx_mapping = {'https://docs.python.org/': None}

View File

@ -589,7 +589,7 @@ directive::
will generate the following HTML output: will generate the following HTML output:
.. code:: html .. code-block:: html
<meta name="description" content="The Sphinx documentation builder"> <meta name="description" content="The Sphinx documentation builder">
<meta name="keywords" content="Sphinx, documentation, builder"> <meta name="keywords" content="Sphinx, documentation, builder">

View File

@ -522,6 +522,7 @@ __ https://pygments.org/docs/lexers
.. rst:directive:: .. code-block:: [language] .. rst:directive:: .. code-block:: [language]
.. sourcecode:: [language] .. sourcecode:: [language]
.. code:: [language]
Example:: Example::
@ -953,7 +954,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:: rst .. code-block:: rst
.. index:: single: execution .. index:: single: execution
single: execution; context single: execution; context
@ -966,7 +967,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:: rst .. code-block:: rst
.. index:: pair: loop; statement .. index:: pair: loop; statement
@ -976,7 +977,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:: rst .. code-block:: rst
.. index:: triple: module; search; path .. index:: triple: module; search; path
@ -986,7 +987,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:: rst .. code-block:: rst
.. index:: see: entry; other .. index:: see: entry; other