Contents
- Supports situations where there is no source file name available to the extension, such as when using
sphinx_toolbox.rest_example
.
- Support Python 3.13.
- In MyST documents, support the
myst_sub_delimiters
option. This means you can use the{{replace-me}}
syntax in MyST documents.
- Bump the minimum supported version of Sphinx to 7.3.5.
- Remove support for
sphinx-prompt
. Please create a GitHub issue if you have a use case for this extension which is not covered by the built-in Sphinx functionality.
- Add
substitution-download
role.
- Add support for MyST. Thanks to Václav Votípka (@eNcacz) for the contribution.
- Bump the minimum supported version of Sphinx to 7.2.0.
- Bump the minimum supported version of docutils to 0.19.
sphinx-prompt
is no longer an optional dependency, meaning you can remove the[prompt]
extras dependency specification.- Remove the need to specify the
sphinx-prompt
extension inconf.py
in order to use theprompt
directive. - Support Python 3.12
- Drop support for Python 3.9
- Breaking change: The required Sphinx version is at least 4.0.
sphinx-prompt
is now an optional dependency. Thanks go to @dgarcia360 for this change.
- Ensure non-lower-case replacements can also be substituted in the inline substitution code role.
- Ensure non-lower-case replacements can also be substituted. Thanks go to @Julian for this change.
- Breaking change: Use
:substitutions:
option oncode-block
orprompt
rather than new directives.
- Breaking change: Use the default Sphinx replacements, rather than a custom variable. Thanks go to @sbaudoin for the original code for this change. Please make a GitHub issue if you have a use case which this does not suit.
- Support Sphinx 2.0.0.
- Make
substitution
a list, not a tuple.
- Add
substitution-code-block
directive.
- Initial release with
substitution-prompt
.