Rename rst_prologue to rst_prolog and document it.

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.
 

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

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),
 

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:
+                if self.config.rst_prolog:
-                    data = self.config.rst_prologue + '\n' + data
+                    data = self.config.rst_prolog + '\n' + data
                 return data
 
         # publish manually