diff --git a/CHANGES b/CHANGES index 7146251c2..b959a251f 100644 --- a/CHANGES +++ b/CHANGES @@ -15,11 +15,11 @@ Incompatible changes * PR#269, #1476: replace ```` tag by ````. User customized stylesheets should be updated If the css contain some styles for ``tt>`` tag. Thanks to Takeshi Komiya. -* #1543: :confval:`templates_path` is automatically added to - :confval:`exclude_patterns` to avoid reading autosummary rst templates in the +* #1543: `templates_path` is automatically added to + `exclude_patterns` to avoid reading autosummary rst templates in the templates directory. -* Custom domains should implement the new :meth:`~Domain.resolve_any_xref` - method to make the :rst:role:`any` role work properly. +* Custom domains should implement the new `Domain.resolve_any_xref` + method to make the `any` role work properly. Features added -------------- @@ -28,27 +28,27 @@ Features added * Add support for docutils 0.12 * Added ``sphinx.ext.napoleon`` extension for NumPy and Google style docstring support. -* Added the :rst:role:`any` role that can be used to find a cross-reference of +* Added the `any` role that can be used to find a cross-reference of *any* type in *any* domain. Custom domains should implement the new - :meth:`~Domain.resolve_any_xref` method to make this work properly. + `Domain.resolve_any_xref` method to make this work properly. * Exception logs now contain the last 10 messages emitted by Sphinx. * Added support for extension versions (a string returned by ``setup()``, these can be shown in the traceback log files). Version requirements for extensions - can be specified in projects using the new :confval:`needs_extensions` config + can be specified in projects using the new `needs_extensions` config value. -* Changing the default role within a document with the :rst:dir:`default-role` +* Changing the default role within a document with the :dudir:`default-role` directive is now supported. * PR#214: Added stemming support for 14 languages, so that the built-in document search can now handle these. Thanks to Shibukawa Yoshiki. * PR#202: Allow "." and "~" prefixed references in ``:param:`` doc fields for Python. -* PR#184: Add :confval:`autodoc_mock_imports`, allowing to mock imports of +* PR#184: Add `autodoc_mock_imports`, allowing to mock imports of external modules that need not be present when autodocumenting. * #925: Allow list-typed config values to be provided on the command line, like ``-D key=val1,val2``. -* #668: Allow line numbering of ``code-block`` and ``literalinclude`` directives +* #668: Allow line numbering of `code-block` and `literalinclude` directives to start at an arbitrary line number, with a new ``lineno-start`` option. -* PR#172, PR#266: The :rst:dir:`code-block` and :rst:dir:`literalinclude` +* PR#172, PR#266: The `code-block` and `literalinclude` directives now can have a ``caption`` option that shows a filename before the code in the output. Thanks to Nasimul Haque, Takeshi Komiya. * Prompt for the document language in sphinx-quickstart. @@ -63,15 +63,15 @@ Features added for the ids defined on the node. Thanks to Olivier Heurtier. * PR#229: Allow registration of other translators. Thanks to Russell Sim. * Add app.set_translator() API to register or override a Docutils translator - class like :confval:`html_translator_class`. + class like `html_translator_class`. * PR#267, #1134: add 'diff' parameter to literalinclude. Thanks to Richard Wall and WAKAYAMA shirou. * PR#272: Added 'bizstyle' theme. Thanks to Shoji KUMAGAI. * Automatically compile ``*.mo`` files from ``*.po`` files when - :confval:`gettext_auto_build` is True (default) and ``*.po`` is newer than + `gettext_auto_build` is True (default) and ``*.po`` is newer than ``*.mo`` file. -* #623: :mod:`~sphinx.ext.viewcode` supports imported function/class aliases. -* PR#275: :mod:`~sphinx.ext.intersphinx` supports multiple target for the +* #623: `sphinx.ext.viewcode` supports imported function/class aliases. +* PR#275: `sphinx.ext.intersphinx` supports multiple target for the inventory. Thanks to Brigitta Sipocz. Bugs fixed @@ -81,7 +81,7 @@ Bugs fixed * #1563: :meth:`~sphinx.application.Sphinx.add_search_language` raises AssertionError for correct type of argument. Thanks to rikoman. * #1174: Fix smart quotes being applied inside roles like :rst:role:`program` or - :rst:role:`makevar`. + `makevar`. * #1335: Fix autosummary template overloading with exclamation prefix like ``{% extends "!autosummary/class.rst" %}`` cause infinite recursive function call. This was caused by PR#181. @@ -90,7 +90,7 @@ Bugs fixed This was caused by a change for #1138. * #1340: Can't search alphabetical words on the HTML quick search generated with language='ja'. -* #1319: Do not crash if the :confval:`html_logo` file does not exist. +* #1319: Do not crash if the `html_logo` file does not exist. * #603: Do not use the HTML-ized title for building the search index (that resulted in "literal" being found on every page with a literal in the title). @@ -107,7 +107,7 @@ Bugs fixed if they contain uppercase letters. * #923: Take the entire LaTeX document into account when caching pngmath-generated images. This rebuilds them correctly when - :confval:`pngmath_latex_preamble` changes. + `pngmath_latex_preamble` changes. * #901: Emit a warning when using docutils' new "math" markup without a Sphinx math extension active. * #845: In code blocks, when the selected lexer fails, display line numbers @@ -124,14 +124,14 @@ Bugs fixed * #1155: Fix autodocumenting C-defined methods as attributes in Python 3. * #1233: Allow finding both Python classes and exceptions with the "class" and "exc" roles in intersphinx. -* #1198: Allow "image" for the "figwidth" option of the :rst:dir:`figure` +* #1198: Allow "image" for the "figwidth" option of the :dudir:`figure` directive as documented by docutils. * #1152: Fix pycode parsing errors of Python 3 code by including two grammar versions for Python 2 and 3, and loading the appropriate version for the running Python version. * #1017: Be helpful and tell the user when the argument to :rst:dir:`option` does not match the required format. -* #1345: Fix two bugs with :confval:`nitpick_ignore`; now you don't have to +* #1345: Fix two bugs with `nitpick_ignore`; now you don't have to remove the store environment for changes to have effect. * #1072: In the JS search, fix issues searching for upper-cased words by lowercasing words before stemming. @@ -154,12 +154,12 @@ Bugs fixed * #1300: Fix references not working in translated documents in some instances. * #1283: Fix a bug in the detection of changed files that would try to access doctrees of deleted documents. -* #1330: Fix :confval:`exclude_patterns` behavior with subdirectories in the - :confval:`html_static_path`. +* #1330: Fix `exclude_patterns` behavior with subdirectories in the + `html_static_path`. * #1323: Fix emitting empty ``