diff --git a/CHANGES b/CHANGES index 3d0091093..2adb9f910 100644 --- a/CHANGES +++ b/CHANGES @@ -15,6 +15,8 @@ Release 1.0 (in development) * Added ``tab-width`` option to ``literalinclude`` directive. +* Added ``rst_prolog`` config value. + * Added ``html_secnumber_suffix`` config value to control section numbering format. diff --git a/doc/config.rst b/doc/config.rst index 4a7e0e5e3..97a4e3440 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -182,6 +182,13 @@ General configuration .. versionadded:: 0.6 +.. confval:: rst_prolog + + A string of reStructuredText that will be included at the beginning of every + source file that is read. + + .. versionadded:: 1.0 + .. confval:: default_role .. index:: default; role diff --git a/sphinx/config.py b/sphinx/config.py index f2e6d57bc..bc89f336c 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -59,7 +59,7 @@ class Config(object): keep_warnings = (False, 'env'), modindex_common_prefix = ([], 'html'), rst_epilog = (None, 'env'), - rst_prologue = (None, 'env'), + rst_prolog = (None, 'env'), trim_doctest_flags = (True, 'env'), needs_sphinx = (None, None), diff --git a/sphinx/environment.py b/sphinx/environment.py index 4e9bedb20..031c02130 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -590,8 +590,8 @@ class BuildEnvironment: data = arg[0] if self.config.rst_epilog: data = data + '\n' + self.config.rst_epilog + '\n' - if self.config.rst_prologue: - data = self.config.rst_prologue + '\n' + data + if self.config.rst_prolog: + data = self.config.rst_prolog + '\n' + data return data # publish manually