Extensions for Sphinx which allow substitutions.
$ pip install Sphinx-Substitution-Extensions
This supports Python 3.8+.
- Add the following to
conf.py
:
# sphinx-prompt must be the first of these two.
extensions += ['sphinx-prompt', 'sphinx_substitution_extensions']
- Set the following variable in
conf.py
:
rst_prolog = """
.. |release| replace:: 0.1
.. |author| replace:: Eleanor
"""
This will replace |release|
in the new directives with 0.1
, and |author|
with Eleanor
.
This adds a :substitutions:
option to Sphinx's built-in code-block directive.
.. code-block:: bash
:substitutions:
echo "|author| released version |release|"
This adds a :substitutions:
option to sphinx-prompt.
.. prompt:: bash
:substitutions:
echo "|author| released version |release|"
:substitution-code:`echo "|author| released version |release|"`
Thanks to @sbrunner and other contributors for sphinx-prompt. substitution-prompt
is based on sphinx-prompt.
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.
See CONTRIBUTING.rst.