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

pfalcon · pfalcon · commit ebce7984c66b · 2017-07-02T15:15:31.000+03:00
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.
diff --git a/docs/conf.py b/docs/conf.py
@@ -139,6 +139,12 @@
 # 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 ----------------------------------------------
 
diff --git a/docs/templates/replace.inc b/docs/templates/replace.inc
@@ -0,0 +1 @@
+.. # This file is intended for global "replace" definitions.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+.. # This file is intended for global "replace" definitions.`