Development Status
- 5 - Production/Stable
Environment
- Web Environment
Framework
- Pytest
Operating System
- Microsoft :: Windows
- POSIX
Programming Language
- Python :: 3 :: Only
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
Sphinx Substitution Extensions
Extensions for Sphinx which allow substitutions within code blocks.
Installation
Sphinx Substitution Extensions is compatible with Sphinx 8.2.0+ using Python 3.10+.
$ pip install Sphinx-Substitution-ExtensionsrST setup
Add the following to conf.py to enable the extension:
"""Configuration for Sphinx."""
extensions = ["sphinxcontrib.spelling"] # Example existing extensions
extensions += ["sphinx_substitution_extensions"]Set the following variable in conf.py to define substitutions:
"""Configuration for Sphinx."""
rst_prolog = """
.. |release| replace:: 0.1
.. |author| replace:: Eleanor
"""This will replace |release| in the new directives with 0.1, and |author| with Eleanor.
Using substitutions in rST documents
code-block
This adds a :substitutions: option to Sphinx’s built-in code-block directive.
.. code-block:: shell
:substitutions:
echo "|author| released version |release|"Inline :substitution-code:
:substitution-code:`echo "|author| released version |release|"`substitution-download
:substitution-download:`|author|'s manuscript <|author|_manuscript.txt>`literalinclude
This adds :content-substitutions: and :path-substitutions: options to Sphinx’s built-in literalinclude directive.
Replace substitutions in the content of the included file:
.. literalinclude:: path/to/file.txt
:content-substitutions:Replace substitutions in the file path:
.. literalinclude:: path/to/|author|_file.txt
:path-substitutions:image
This adds a :path-substitutions: option to Sphinx’s built-in image directive.
Replace substitutions in the image path:
.. image:: path/to/|author|_diagram.png
:path-substitutions:
:alt: DiagramMyST Markdown setup
Add sphinx_substitution_extensions to extensions in conf.py to enable the extension:
"""Configuration for Sphinx."""
extensions = ["myst_parser"] # Example existing extensions
extensions += ["sphinx_substitution_extensions"]Set the following variables in conf.py to define substitutions:
"""Configuration for Sphinx."""
myst_enable_extensions = ["substitution"]
myst_substitutions = {
"release": "0.1",
"author": "Eleanor",
}This will replace |release| in the new directives with 0.1, and |author| with Eleanor.
Enabling substitutions by default
By default, you need to explicitly add the :substitutions: flag to code-block directives, and :content-substitutions: or :path-substitutions: flags to literalinclude directives.
If you want substitutions to be applied by default without needing these flags, you can set the following in conf.py:
"""Configuration for Sphinx."""
substitutions_default_enabled = TrueWhen this is enabled:
All code-block directives will have substitutions applied automatically
All literalinclude directives will have both content and path substitutions applied automatically
You can disable substitutions for specific directives when the default is enabled:
.. code-block:: shell
:nosubstitutions:
echo "This |will| not be substituted"
.. literalinclude:: path/to/file.txt
:nocontent-substitutions:
.. literalinclude:: path/to/|literal|_file.txt
:nopath-substitutions:Using substitutions in MyST Markdown
code-block
This adds a :substitutions: option to Sphinx’s built-in code-block directive.
```{code-block} bash
:substitutions:
echo "|author| released version |release|"
```As well as using |author|, you can also use {{author}}. This will respect the value of myst_sub_delimiters as set in conf.py.
Inline :substitution-code:
{substitution-code}`echo "|author| released version |release|"`substitution-download
{substitution-download}`|author|'s manuscript <|author|_manuscript.txt>`literalinclude
This adds :content-substitutions: and :path-substitutions: options to Sphinx’s built-in literalinclude directive.
Replace substitutions in the content of the included file:
```{literalinclude} path/to/file.txt
:content-substitutions:
```Replace substitutions in the file path:
```{literalinclude} path/to/|author|_file.txt
:path-substitutions:
```image
This adds a :path-substitutions: option to Sphinx’s built-in image directive.
Replace substitutions in the image path:
```{image} path/to/|author|_diagram.png
:path-substitutions:
:alt: Diagram
```Credits
ClusterHQ Developers
This package is largely inspired by code written for Flocker by ClusterHQ. Developers of the relevant code include, at least, Jon Giddy and Tom Prince.
Contributing
See CONTRIBUTING.rst.
