Substitutions

Local

Super handy. Define them at the bottom of your document, like this:

.. substitutions

.. |solve| image:: /common/guilib/Icons/execute_active.png

Use them by the initial label ( |solve| above, for instance) in the body of your document. This:

Press the Execute button ( |solve| ) to run the data file.

Will get you this:

Press the Execute button ( ) to run the data file.

Global

The conf.py provides a “prolog” section, which is material that gets inserted into the top of ALL documents, thereby making it “global.” This includes a number of substitutions and some custom roles – these do not need to be declared within a document. Notably, this includes code names. The prolog block in conf.py is: