diff --git a/doc/config.rst b/doc/config.rst index 368674692..b4d7662eb 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -412,8 +412,6 @@ Options for HTML output These options influence HTML as well as HTML Help output, and other builders that use Sphinx' HTMLWriter class. -.. XXX document html_context - .. confval:: html_theme The "theme" that the HTML output should use. See the :doc:`section about @@ -461,6 +459,14 @@ that use Sphinx' HTMLWriter class. .. versionadded:: 0.4 +.. confval:: html_context + + A dictionary of values to pass into the template engine's context for all + pages. Single values can also be put in this dictionary using the + :option:`-A` command-line option of ``sphinx-build``. + + .. versionadded:: 0.5 + .. confval:: html_logo If given, this must be the name of an image file that is the logo of the diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index 6c4a147ac..c5c90d732 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -121,8 +121,8 @@ inserting them into the page source under a suitable :rst:dir:`py:module`, .. versionadded:: 1.1 * For classes and exceptions, members inherited from base classes will be - left out, unless you give the ``inherited-members`` flag option, in - addition to ``members``:: + left out when documenting all members, unless you give the + ``inherited-members`` flag option, in addition to ``members``:: .. autoclass:: Noodle :members: diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py index f11a40595..6e0300abc 100644 --- a/sphinx/directives/__init__.py +++ b/sphinx/directives/__init__.py @@ -33,7 +33,7 @@ except AttributeError: # RE to strip backslash escapes nl_escape_re = re.compile(r'\\\n') -strip_backslash_re = re.compile(r'\\(?=[^\\])') +strip_backslash_re = re.compile(r'\\(.)') class ObjectDescription(Directive): @@ -63,7 +63,7 @@ class ObjectDescription(Directive): """ lines = nl_escape_re.sub('', self.arguments[0]).split('\n') # remove backslashes to support (dummy) escapes; helps Vim highlighting - return [strip_backslash_re.sub('', line.strip()) for line in lines] + return [strip_backslash_re.sub(r'\1', line.strip()) for line in lines] def handle_signature(self, sig, signode): """ diff --git a/tests/root/markup.txt b/tests/root/markup.txt index 8f070f4cc..71197689a 100644 --- a/tests/root/markup.txt +++ b/tests/root/markup.txt @@ -158,8 +158,8 @@ Tables .. tabularcolumns:: |L|p{5cm}|R| - .. _my-table: + .. table:: my table +----+----------------+----+