summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorSandrine Bailleux <sandrine.bailleux@arm.com>2019-05-23 13:14:00 +0000
committerTrustedFirmware Code Review <review@review.trustedfirmware.org>2019-05-23 13:14:00 +0000
commitced1711297347f24fee45e75e73c7767507a0982 (patch)
tree56fa3ad15c1f5b8a6d2b2953cb7c0c2a4eb4ba1e /docs/conf.py
parent1665bcd0cf75efc862684418480be0076eb8c920 (diff)
parente1c5026ac7e9da1b74047bf8cb9be2a5c9564532 (diff)
Merge changes from topic "pb/sphinx-doc" into integration
* changes: doc: Use proper note and warning annotations doc: Refactor contributor acknowledgements doc: Reorganise images and update links doc: Set correct syntax highlighting style doc: Add minimal glossary doc: Remove per-page contents lists doc: Make checkpatch ignore rst files doc: Format security advisory titles and headings doc: Reformat platform port documents doc: Normalise section numbering and headings doc: Reword document titles
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 0fcc50d2..697b8711 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -9,6 +9,8 @@
#
# See the options documentation at http://www.sphinx-doc.org/en/master/config
+import os
+
# -- Project information -----------------------------------------------------
project = 'Trusted Firmware-A'
@@ -16,7 +18,6 @@ project = 'Trusted Firmware-A'
version = '2.1'
release = version # We don't need these to be distinct
-
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
@@ -48,6 +49,10 @@ exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
+# Load the contents of the global substitutions file into the 'rst_prolog'
+# variable. This ensures that the substitutions are all inserted into each page.
+with open('global_substitutions.txt', 'r') as subs:
+ rst_prolog = subs.read()
# -- Options for HTML output -------------------------------------------------