From ebce7984c66b4d977f4540506e243cf65a80db2f Mon Sep 17 00:00:00 2001
From: Paul Sokolovsky <pfalcon@users.sourceforge.net>
Date: Sun, 2 Jul 2017 15:15:31 +0300
Subject: [PATCH] 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.
---
 docs/conf.py               | 6 ++++++
 docs/templates/replace.inc | 1 +
 2 files changed, 7 insertions(+)
 create mode 100644 docs/templates/replace.inc

diff --git a/docs/conf.py b/docs/conf.py
index bb1d61358..b9b112557 100755
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -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 ----------------------------------------------
 
diff --git a/docs/templates/replace.inc b/docs/templates/replace.inc
new file mode 100644
index 000000000..6ed79cc7c
--- /dev/null
+++ b/docs/templates/replace.inc
@@ -0,0 +1 @@
+.. # This file is intended for global "replace" definitions.
-- 
GitLab