Skip to content

feat: define myst_substitutions per version #1476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgarcia360 merged 2 commits into from
Aug 20, 2025
Merged

feat: define myst_substitutions per version #1476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea8ca68
feat: define myst_substitutions per version
dgarcia360 Aug 19, 2025
7185a29
docs: update readme
dgarcia360 Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions extensions/sphinx-multiversion/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ See https://github.com/scylladb/sphinx-scylladb-theme/pull/891
The following properties can be defined on a per-version basis.

* `rst_prolog`
* `myst_substitutions`: Introduced in 0.3.3
* `exclude_patterns`: Introduced in 0.3.2

## License
Expand Down
2 changes: 1 addition & 1 deletion extensions/sphinx-multiversion/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
author="Jan Holthuis",
author_email="holthuis.jan@googlemail.com",
url="https://holzhaus.github.io/sphinx-multiversion/",
version="0.3.2",
version="0.3.3",
install_requires=["sphinx >= 2.1"],
license="BSD",
packages=["sphinx_multiversion"],
Expand Down
2 changes: 1 addition & 1 deletion extensions/sphinx-multiversion/sphinx_multiversion/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from .main import main
from .sphinx import setup

__version__ = "0.3.1"
__version__ = "0.3.3"

__all__ = [
"setup",
Expand Down
4 changes: 4 additions & 0 deletions extensions/sphinx-multiversion/sphinx_multiversion/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,11 +308,15 @@ def main(argv=None):

current_sourcedir = os.path.join(repopath, sourcedir)
project = sphinx_project.Project(current_sourcedir, source_suffixes)

myst_substitutions = getattr(current_config, 'myst_substitutions', {})

metadata[gitref.name] = {
"name": gitref.name,
"version": current_config.version,
"release": current_config.release,
"rst_prolog": current_config.rst_prolog,
"myst_substitutions": myst_substitutions,
"exclude_patterns": current_config.exclude_patterns,
"is_released": bool(
re.match(config.smv_released_pattern, gitref.refname)
Expand Down
1 change: 1 addition & 0 deletions extensions/sphinx-multiversion/sphinx_multiversion/sphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ def config_inited(app, config):
config.version = data["version"]
config.release = data["release"]
config.rst_prolog = data["rst_prolog"]
config.myst_substitutions = data["myst_substitutions"]
config.exclude_patterns = data["exclude_patterns"]
config.today = old_config.today
if not config.today:
Expand Down