docs/conf.py: Add file for global replacements definition.

The idea is to allow to define a kind of "macros" for repeatitive text,
so all occurrances can be updated in one place. Unfortunately, RST doesn't
support replacements with arguments, which limits usefulness of them and
should be taken into account.
This commit is contained in:
Paul Sokolovsky 2017-07-02 15:15:31 +03:00
parent 5f0c56bcf1
commit ebce7984c6
2 changed files with 7 additions and 0 deletions

View File

@ -139,6 +139,12 @@ pygments_style = 'sphinx'
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# Global include files. Sphinx docs suggest using rst_epilog in preference
# of rst_prolog, so we follow. Absolute paths below mean "from the base
# of the doctree".
rst_epilog = """
.. include:: /templates/replace.inc
"""
# -- Options for HTML output ----------------------------------------------

1
docs/templates/replace.inc vendored Normal file
View File

@ -0,0 +1 @@
.. # This file is intended for global "replace" definitions.