Support enabling substitutions by default

[neongreen-sc]

I'm working on a document where many code blocks need substitutions -- is there any way I could enable them in code blocks by default, and use smth like :nosubstitutions: when I want to turn them off?

[adamtheturtle]

This is not currently possible. I support this as an idea though, perhaps with a conf.py setting.

[adamtheturtle]

I haven't tested this, but could you do something like this in your conf.py:

from sphinx.directives.code import CodeBlock
from docutils.parsers.rst import directives

class SubstitutionsCodeBlock(CodeBlock):
    """
    Custom CodeBlock that automatically applies the :substitutions: option.
    """
    option_spec = CodeBlock.option_spec.copy()
    option_spec['substitutions'] = directives.flag

    def run(self):
        self.options['substitutions'] = True
        return super().run()

def setup(app):
    app.add_directive('substitutions-code-block', SubstitutedCodeBlock)

Then you can use substitutions-code-block almost everywhere, and code-block when you don't want substitutions.