{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Adds substitution support to Sphinx directives, allowing variable replacement within code blocks, file paths, and other content during documentation builds.","skillfed_tags":["sphinx-extension","documentation-tooling"],"use_cases":["Document version numbers and release dates that appear in code examples and download links without manual updates","Replace author names, product names, or environment-specific values across code blocks and file paths in multi-author or multi-environment docs","Generate dynamic file paths in `literalinclude` and `include` directives based on substitution variables","Maintain consistent branding or configuration values in inline code snippets and hyperlink targets"],"what_it_does":"This package extends Sphinx with directives that perform variable substitution in documentation content. It works by registering new options (`:substitutions:`, `:content-substitutions:`, `:path-substitutions:`) on Sphinx's built-in directives like `code-block`, `literalinclude`, `include`, and `image`, plus adds new directives like `:substitution-code:` and `:substitution-download:`. Substitutions are defined in `conf.py` via `rst_prolog` for reStructuredText or `myst_substitutions` for MyST Markdown.\n\nThe package supports both reStructuredText and MyST Markdown syntax. Variables can be scoped globally (in `rst_prolog` or `myst_substitutions`) or per-document (in frontmatter for Markdown). By default, substitution flags must be added explicitly to each directive; a `substitutions_default_enabled` setting applies them automatically across all compatible directives. It depends on sphinx, docutils, myst-parser, and beartype, and requires Python 3.11 or later.","worth_installing":"Yes. Active maintenance, low install friction, no known vulnerabilities, and permissive MIT license. Install if you maintain Sphinx documentation with repeated variable values in code examples or file paths. Skip if your documentation is static and does not benefit from templating."},"id":"sphinx-substitution-extensions","links":{"html":"https://skillfed.io/packages/sphinx-substitution-extensions","md":"https://skillfed.io/packages/sphinx-substitution-extensions.md","pypi":"https://pypi.org/project/sphinx-substitution-extensions/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-08-13","license_spdx":"MIT","license_treatment":"permissive","name":"sphinx-substitution-extensions","python_support":"supports_current","summary":"Extensions for Sphinx which allow for substitutions."},"popularity":{"monthly_downloads":253757,"position":8509,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"2026.8.13.1"}