mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Use "any" role in changelog.
This commit is contained in:
parent
c3eb669f8a
commit
109cb873de
180
CHANGES
180
CHANGES
@ -15,11 +15,11 @@ Incompatible changes
|
|||||||
* PR#269, #1476: replace ``<tt>`` tag by ``<code>``. User customized stylesheets
|
* PR#269, #1476: replace ``<tt>`` tag by ``<code>``. User customized stylesheets
|
||||||
should be updated If the css contain some styles for ``tt>`` tag.
|
should be updated If the css contain some styles for ``tt>`` tag.
|
||||||
Thanks to Takeshi Komiya.
|
Thanks to Takeshi Komiya.
|
||||||
* #1543: :confval:`templates_path` is automatically added to
|
* #1543: `templates_path` is automatically added to
|
||||||
:confval:`exclude_patterns` to avoid reading autosummary rst templates in the
|
`exclude_patterns` to avoid reading autosummary rst templates in the
|
||||||
templates directory.
|
templates directory.
|
||||||
* Custom domains should implement the new :meth:`~Domain.resolve_any_xref`
|
* Custom domains should implement the new `Domain.resolve_any_xref`
|
||||||
method to make the :rst:role:`any` role work properly.
|
method to make the `any` role work properly.
|
||||||
|
|
||||||
Features added
|
Features added
|
||||||
--------------
|
--------------
|
||||||
@ -28,27 +28,27 @@ Features added
|
|||||||
* Add support for docutils 0.12
|
* Add support for docutils 0.12
|
||||||
* Added ``sphinx.ext.napoleon`` extension for NumPy and Google style docstring
|
* Added ``sphinx.ext.napoleon`` extension for NumPy and Google style docstring
|
||||||
support.
|
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
|
*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.
|
* Exception logs now contain the last 10 messages emitted by Sphinx.
|
||||||
* Added support for extension versions (a string returned by ``setup()``, these
|
* 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 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.
|
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.
|
directive is now supported.
|
||||||
* PR#214: Added stemming support for 14 languages, so that the built-in document
|
* PR#214: Added stemming support for 14 languages, so that the built-in document
|
||||||
search can now handle these. Thanks to Shibukawa Yoshiki.
|
search can now handle these. Thanks to Shibukawa Yoshiki.
|
||||||
* PR#202: Allow "." and "~" prefixed references in ``:param:`` doc fields
|
* PR#202: Allow "." and "~" prefixed references in ``:param:`` doc fields
|
||||||
for Python.
|
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.
|
external modules that need not be present when autodocumenting.
|
||||||
* #925: Allow list-typed config values to be provided on the command line,
|
* #925: Allow list-typed config values to be provided on the command line,
|
||||||
like ``-D key=val1,val2``.
|
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.
|
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
|
directives now can have a ``caption`` option that shows a filename before the
|
||||||
code in the output. Thanks to Nasimul Haque, Takeshi Komiya.
|
code in the output. Thanks to Nasimul Haque, Takeshi Komiya.
|
||||||
* Prompt for the document language in sphinx-quickstart.
|
* 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.
|
for the ids defined on the node. Thanks to Olivier Heurtier.
|
||||||
* PR#229: Allow registration of other translators. Thanks to Russell Sim.
|
* PR#229: Allow registration of other translators. Thanks to Russell Sim.
|
||||||
* Add app.set_translator() API to register or override a Docutils translator
|
* 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
|
* PR#267, #1134: add 'diff' parameter to literalinclude. Thanks to Richard Wall
|
||||||
and WAKAYAMA shirou.
|
and WAKAYAMA shirou.
|
||||||
* PR#272: Added 'bizstyle' theme. Thanks to Shoji KUMAGAI.
|
* PR#272: Added 'bizstyle' theme. Thanks to Shoji KUMAGAI.
|
||||||
* Automatically compile ``*.mo`` files from ``*.po`` files when
|
* 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.
|
``*.mo`` file.
|
||||||
* #623: :mod:`~sphinx.ext.viewcode` supports imported function/class aliases.
|
* #623: `sphinx.ext.viewcode` supports imported function/class aliases.
|
||||||
* PR#275: :mod:`~sphinx.ext.intersphinx` supports multiple target for the
|
* PR#275: `sphinx.ext.intersphinx` supports multiple target for the
|
||||||
inventory. Thanks to Brigitta Sipocz.
|
inventory. Thanks to Brigitta Sipocz.
|
||||||
|
|
||||||
Bugs fixed
|
Bugs fixed
|
||||||
@ -81,7 +81,7 @@ Bugs fixed
|
|||||||
* #1563: :meth:`~sphinx.application.Sphinx.add_search_language` raises
|
* #1563: :meth:`~sphinx.application.Sphinx.add_search_language` raises
|
||||||
AssertionError for correct type of argument. Thanks to rikoman.
|
AssertionError for correct type of argument. Thanks to rikoman.
|
||||||
* #1174: Fix smart quotes being applied inside roles like :rst:role:`program` or
|
* #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
|
* #1335: Fix autosummary template overloading with exclamation prefix like
|
||||||
``{% extends "!autosummary/class.rst" %}`` cause infinite recursive function
|
``{% extends "!autosummary/class.rst" %}`` cause infinite recursive function
|
||||||
call. This was caused by PR#181.
|
call. This was caused by PR#181.
|
||||||
@ -90,7 +90,7 @@ Bugs fixed
|
|||||||
This was caused by a change for #1138.
|
This was caused by a change for #1138.
|
||||||
* #1340: Can't search alphabetical words on the HTML quick search generated
|
* #1340: Can't search alphabetical words on the HTML quick search generated
|
||||||
with language='ja'.
|
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
|
* #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
|
resulted in "literal" being found on every page with a literal in the
|
||||||
title).
|
title).
|
||||||
@ -107,7 +107,7 @@ Bugs fixed
|
|||||||
if they contain uppercase letters.
|
if they contain uppercase letters.
|
||||||
* #923: Take the entire LaTeX document into account when caching
|
* #923: Take the entire LaTeX document into account when caching
|
||||||
pngmath-generated images. This rebuilds them correctly when
|
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
|
* #901: Emit a warning when using docutils' new "math" markup without a Sphinx
|
||||||
math extension active.
|
math extension active.
|
||||||
* #845: In code blocks, when the selected lexer fails, display line numbers
|
* #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.
|
* #1155: Fix autodocumenting C-defined methods as attributes in Python 3.
|
||||||
* #1233: Allow finding both Python classes and exceptions with the "class" and
|
* #1233: Allow finding both Python classes and exceptions with the "class" and
|
||||||
"exc" roles in intersphinx.
|
"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.
|
directive as documented by docutils.
|
||||||
* #1152: Fix pycode parsing errors of Python 3 code by including two grammar
|
* #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
|
versions for Python 2 and 3, and loading the appropriate version for the
|
||||||
running Python version.
|
running Python version.
|
||||||
* #1017: Be helpful and tell the user when the argument to :rst:dir:`option`
|
* #1017: Be helpful and tell the user when the argument to :rst:dir:`option`
|
||||||
does not match the required format.
|
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.
|
remove the store environment for changes to have effect.
|
||||||
* #1072: In the JS search, fix issues searching for upper-cased words by
|
* #1072: In the JS search, fix issues searching for upper-cased words by
|
||||||
lowercasing words before stemming.
|
lowercasing words before stemming.
|
||||||
@ -154,12 +154,12 @@ Bugs fixed
|
|||||||
* #1300: Fix references not working in translated documents in some instances.
|
* #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
|
* #1283: Fix a bug in the detection of changed files that would try to access
|
||||||
doctrees of deleted documents.
|
doctrees of deleted documents.
|
||||||
* #1330: Fix :confval:`exclude_patterns` behavior with subdirectories in the
|
* #1330: Fix `exclude_patterns` behavior with subdirectories in the
|
||||||
:confval:`html_static_path`.
|
`html_static_path`.
|
||||||
* #1323: Fix emitting empty ``<ul>`` tags in the HTML writer, which is not
|
* #1323: Fix emitting empty ``<ul>`` tags in the HTML writer, which is not
|
||||||
valid HTML.
|
valid HTML.
|
||||||
* #1147: Don't emit a sidebar search box in the "singlehtml" builder.
|
* #1147: Don't emit a sidebar search box in the "singlehtml" builder.
|
||||||
* PR#211: When checking for existence of the :confval:`html_logo` file, check
|
* PR#211: When checking for existence of the `html_logo` file, check
|
||||||
the full relative path and not the basename.
|
the full relative path and not the basename.
|
||||||
* #1357: Option names documented by :rst:dir:`option` are now again allowed to
|
* #1357: Option names documented by :rst:dir:`option` are now again allowed to
|
||||||
not start with a dash or slash, and referencing them will work correctly.
|
not start with a dash or slash, and referencing them will work correctly.
|
||||||
@ -215,8 +215,8 @@ Bugs fixed
|
|||||||
qualified name. It should be rather easy to change this behaviour and
|
qualified name. It should be rather easy to change this behaviour and
|
||||||
potentially index by namespaces/classes as well.
|
potentially index by namespaces/classes as well.
|
||||||
|
|
||||||
* PR#258, #939: Add dedent option for :rst:dir:`code-block` and
|
* PR#258, #939: Add dedent option for `code-block` and
|
||||||
:rst:dir:`literal-include`. Thanks to Zafar Siddiqui.
|
`literalinclude`. Thanks to Zafar Siddiqui.
|
||||||
* PR#268: Fix numbering section does not work at singlehtml mode. It still
|
* PR#268: Fix numbering section does not work at singlehtml mode. It still
|
||||||
ad-hoc fix because there is a issue that section IDs are conflicted.
|
ad-hoc fix because there is a issue that section IDs are conflicted.
|
||||||
Thanks to Takeshi Komiya.
|
Thanks to Takeshi Komiya.
|
||||||
@ -224,10 +224,10 @@ Bugs fixed
|
|||||||
Takeshi Komiya.
|
Takeshi Komiya.
|
||||||
* PR#274: Set its URL as a default title value if URL appears in toctree.
|
* PR#274: Set its URL as a default title value if URL appears in toctree.
|
||||||
Thanks to Takeshi Komiya.
|
Thanks to Takeshi Komiya.
|
||||||
* PR#276, #1381: :rst:role:`rfc` and :rst:role:`pep` roles support custom link
|
* PR#276, #1381: `rfc` and `pep` roles support custom link
|
||||||
text. Thanks to Takeshi Komiya.
|
text. Thanks to Takeshi Komiya.
|
||||||
* PR#277, #1513: highlights for function pointers in argument list of
|
* PR#277, #1513: highlights for function pointers in argument list of
|
||||||
:rst:dir:`c:function`. Thanks to Takeshi Komiya.
|
`c:function`. Thanks to Takeshi Komiya.
|
||||||
* PR#278: Fix section entries were shown twice if toctree has been put under
|
* PR#278: Fix section entries were shown twice if toctree has been put under
|
||||||
only directive. Thanks to Takeshi Komiya.
|
only directive. Thanks to Takeshi Komiya.
|
||||||
* #1547: pgen2 tokenizer doesn't recognize ``...`` literal (Ellipsis for py3).
|
* #1547: pgen2 tokenizer doesn't recognize ``...`` literal (Ellipsis for py3).
|
||||||
@ -294,7 +294,7 @@ Release 1.2.2 (released Mar 2, 2014)
|
|||||||
Bugs fixed
|
Bugs fixed
|
||||||
----------
|
----------
|
||||||
|
|
||||||
* PR#211: When checking for existence of the :confval:`html_logo` file, check
|
* PR#211: When checking for existence of the `html_logo` file, check
|
||||||
the full relative path and not the basename.
|
the full relative path and not the basename.
|
||||||
* PR#212: Fix traceback with autodoc and ``__init__`` methods without docstring.
|
* PR#212: Fix traceback with autodoc and ``__init__`` methods without docstring.
|
||||||
* PR#213: Fix a missing import in the setup command.
|
* PR#213: Fix a missing import in the setup command.
|
||||||
@ -334,7 +334,7 @@ Bugs fixed
|
|||||||
This was caused by a change for #1138.
|
This was caused by a change for #1138.
|
||||||
* #1340: Can't search alphabetical words on the HTML quick search generated
|
* #1340: Can't search alphabetical words on the HTML quick search generated
|
||||||
with language='ja'.
|
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
|
* #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
|
resulted in "literal" being found on every page with a literal in the
|
||||||
title).
|
title).
|
||||||
@ -351,7 +351,7 @@ Bugs fixed
|
|||||||
if they contain uppercase letters.
|
if they contain uppercase letters.
|
||||||
* #923: Take the entire LaTeX document into account when caching
|
* #923: Take the entire LaTeX document into account when caching
|
||||||
pngmath-generated images. This rebuilds them correctly when
|
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
|
* #901: Emit a warning when using docutils' new "math" markup without a Sphinx
|
||||||
math extension active.
|
math extension active.
|
||||||
* #845: In code blocks, when the selected lexer fails, display line numbers
|
* #845: In code blocks, when the selected lexer fails, display line numbers
|
||||||
@ -368,14 +368,14 @@ Bugs fixed
|
|||||||
* #1155: Fix autodocumenting C-defined methods as attributes in Python 3.
|
* #1155: Fix autodocumenting C-defined methods as attributes in Python 3.
|
||||||
* #1233: Allow finding both Python classes and exceptions with the "class" and
|
* #1233: Allow finding both Python classes and exceptions with the "class" and
|
||||||
"exc" roles in intersphinx.
|
"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.
|
directive as documented by docutils.
|
||||||
* #1152: Fix pycode parsing errors of Python 3 code by including two grammar
|
* #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
|
versions for Python 2 and 3, and loading the appropriate version for the
|
||||||
running Python version.
|
running Python version.
|
||||||
* #1017: Be helpful and tell the user when the argument to :rst:dir:`option`
|
* #1017: Be helpful and tell the user when the argument to :rst:dir:`option`
|
||||||
does not match the required format.
|
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.
|
remove the store environment for changes to have effect.
|
||||||
* #1072: In the JS search, fix issues searching for upper-cased words by
|
* #1072: In the JS search, fix issues searching for upper-cased words by
|
||||||
lowercasing words before stemming.
|
lowercasing words before stemming.
|
||||||
@ -398,8 +398,8 @@ Bugs fixed
|
|||||||
* #1300: Fix references not working in translated documents in some instances.
|
* #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
|
* #1283: Fix a bug in the detection of changed files that would try to access
|
||||||
doctrees of deleted documents.
|
doctrees of deleted documents.
|
||||||
* #1330: Fix :confval:`exclude_patterns` behavior with subdirectories in the
|
* #1330: Fix `exclude_patterns` behavior with subdirectories in the
|
||||||
:confval:`html_static_path`.
|
`html_static_path`.
|
||||||
* #1323: Fix emitting empty ``<ul>`` tags in the HTML writer, which is not
|
* #1323: Fix emitting empty ``<ul>`` tags in the HTML writer, which is not
|
||||||
valid HTML.
|
valid HTML.
|
||||||
* #1147: Don't emit a sidebar search box in the "singlehtml" builder.
|
* #1147: Don't emit a sidebar search box in the "singlehtml" builder.
|
||||||
@ -498,7 +498,7 @@ Features added
|
|||||||
* Support docutils.conf 'writers' and 'html4css1 writer' section in the HTML
|
* Support docutils.conf 'writers' and 'html4css1 writer' section in the HTML
|
||||||
writer. The latex, manpage and texinfo writers also support their respective
|
writer. The latex, manpage and texinfo writers also support their respective
|
||||||
'writers' sections.
|
'writers' sections.
|
||||||
* The new :confval:`html_extra_path` config value allows to specify directories
|
* The new `html_extra_path` config value allows to specify directories
|
||||||
with files that should be copied directly to the HTML output directory.
|
with files that should be copied directly to the HTML output directory.
|
||||||
* Autodoc directives for module data and attributes now support an
|
* Autodoc directives for module data and attributes now support an
|
||||||
``annotation`` option, so that the default display of the data/attribute
|
``annotation`` option, so that the default display of the data/attribute
|
||||||
@ -569,10 +569,10 @@ Incompatible changes
|
|||||||
|
|
||||||
* Removed ``sphinx.util.compat.directive_dwim()`` and
|
* Removed ``sphinx.util.compat.directive_dwim()`` and
|
||||||
``sphinx.roles.xfileref_role()`` which were deprecated since version 1.0.
|
``sphinx.roles.xfileref_role()`` which were deprecated since version 1.0.
|
||||||
* PR#122: the files given in :confval:`latex_additional_files` now override TeX
|
* PR#122: the files given in `latex_additional_files` now override TeX
|
||||||
files included by Sphinx, such as ``sphinx.sty``.
|
files included by Sphinx, such as ``sphinx.sty``.
|
||||||
* PR#124: the node generated by :rst:dir:`versionadded`,
|
* PR#124: the node generated by `versionadded`,
|
||||||
:rst:dir:`versionchanged` and :rst:dir:`deprecated` directives now includes
|
`versionchanged` and `deprecated` directives now includes
|
||||||
all added markup (such as "New in version X") as child nodes, and no
|
all added markup (such as "New in version X") as child nodes, and no
|
||||||
additional text must be generated by writers.
|
additional text must be generated by writers.
|
||||||
* PR#99: the :rst:dir:`seealso` directive now generates admonition nodes instead
|
* PR#99: the :rst:dir:`seealso` directive now generates admonition nodes instead
|
||||||
@ -626,7 +626,7 @@ Features added
|
|||||||
asterisks ("*").
|
asterisks ("*").
|
||||||
- The default value for the ``paragraphindent`` has been changed from 2 to 0
|
- The default value for the ``paragraphindent`` has been changed from 2 to 0
|
||||||
meaning that paragraphs are no longer indented by default.
|
meaning that paragraphs are no longer indented by default.
|
||||||
- #1110: A new configuration value :confval:`texinfo_no_detailmenu` has been
|
- #1110: A new configuration value `texinfo_no_detailmenu` has been
|
||||||
added for controlling whether a ``@detailmenu`` is added in the "Top"
|
added for controlling whether a ``@detailmenu`` is added in the "Top"
|
||||||
node's menu.
|
node's menu.
|
||||||
- Detailed menus are no longer created except for the "Top" node.
|
- Detailed menus are no longer created except for the "Top" node.
|
||||||
@ -635,16 +635,16 @@ Features added
|
|||||||
|
|
||||||
* LaTeX builder:
|
* LaTeX builder:
|
||||||
|
|
||||||
- PR#115: Add ``'transition'`` item in :confval:`latex_elements` for
|
- PR#115: Add ``'transition'`` item in `latex_elements` for
|
||||||
customizing how transitions are displayed. Thanks to Jeff Klukas.
|
customizing how transitions are displayed. Thanks to Jeff Klukas.
|
||||||
- PR#114: The LaTeX writer now includes the "cmap" package by default. The
|
- PR#114: The LaTeX writer now includes the "cmap" package by default. The
|
||||||
``'cmappkg'`` item in :confval:`latex_elements` can be used to control this.
|
``'cmappkg'`` item in `latex_elements` can be used to control this.
|
||||||
Thanks to Dmitry Shachnev.
|
Thanks to Dmitry Shachnev.
|
||||||
- The ``'fontpkg'`` item in :confval:`latex_elements` now defaults to ``''``
|
- The ``'fontpkg'`` item in `latex_elements` now defaults to ``''``
|
||||||
when the :confval:`language` uses the Cyrillic script. Suggested by Dmitry
|
when the `language` uses the Cyrillic script. Suggested by Dmitry
|
||||||
Shachnev.
|
Shachnev.
|
||||||
- The :confval:`latex_documents`, :confval:`texinfo_documents`, and
|
- The `latex_documents`, `texinfo_documents`, and
|
||||||
:confval:`man_pages` configuration values will be set to default values based
|
`man_pages` configuration values will be set to default values based
|
||||||
on the :confval:`master_doc` if not explicitly set in :file:`conf.py`.
|
on the :confval:`master_doc` if not explicitly set in :file:`conf.py`.
|
||||||
Previously, if these values were not set, no output would be generated by
|
Previously, if these values were not set, no output would be generated by
|
||||||
their respective builders.
|
their respective builders.
|
||||||
@ -662,13 +662,13 @@ Features added
|
|||||||
- Added the Docutils-native XML and pseudo-XML builders. See
|
- Added the Docutils-native XML and pseudo-XML builders. See
|
||||||
:class:`XMLBuilder` and :class:`PseudoXMLBuilder`.
|
:class:`XMLBuilder` and :class:`PseudoXMLBuilder`.
|
||||||
- PR#45: The linkcheck builder now checks ``#anchor``\ s for existence.
|
- PR#45: The linkcheck builder now checks ``#anchor``\ s for existence.
|
||||||
- PR#123, #1106: Add :confval:`epub_use_index` configuration value. If
|
- PR#123, #1106: Add `epub_use_index` configuration value. If
|
||||||
provided, it will be used instead of :confval:`html_use_index` for epub
|
provided, it will be used instead of `html_use_index` for epub
|
||||||
builder.
|
builder.
|
||||||
- PR#126: Add :confval:`epub_tocscope` configuration value. The setting
|
- PR#126: Add `epub_tocscope` configuration value. The setting
|
||||||
controls the generation of the epub toc. The user can now also include
|
controls the generation of the epub toc. The user can now also include
|
||||||
hidden toc entries.
|
hidden toc entries.
|
||||||
- PR#112: Add :confval:`epub_show_urls` configuration value.
|
- PR#112: Add `epub_show_urls` configuration value.
|
||||||
|
|
||||||
* Extensions:
|
* Extensions:
|
||||||
|
|
||||||
@ -736,7 +736,7 @@ Bugs fixed
|
|||||||
* #1127: Fix traceback when autodoc tries to tokenize a non-Python file.
|
* #1127: Fix traceback when autodoc tries to tokenize a non-Python file.
|
||||||
* #1126: Fix double-hyphen to en-dash conversion in wrong places such as
|
* #1126: Fix double-hyphen to en-dash conversion in wrong places such as
|
||||||
command-line option names in LaTeX.
|
command-line option names in LaTeX.
|
||||||
* #1123: Allow whitespaces in filenames given to :rst:dir:`literalinclude`.
|
* #1123: Allow whitespaces in filenames given to `literalinclude`.
|
||||||
* #1120: Added improvements about i18n for themes "basic", "haiku" and
|
* #1120: Added improvements about i18n for themes "basic", "haiku" and
|
||||||
"scrolls" that Sphinx built-in. Thanks to Leonardo J. Caballero G.
|
"scrolls" that Sphinx built-in. Thanks to Leonardo J. Caballero G.
|
||||||
* #1118: Updated Spanish translation. Thanks to Leonardo J. Caballero G.
|
* #1118: Updated Spanish translation. Thanks to Leonardo J. Caballero G.
|
||||||
@ -744,7 +744,7 @@ Bugs fixed
|
|||||||
* #1112: Avoid duplicate download files when referenced from documents in
|
* #1112: Avoid duplicate download files when referenced from documents in
|
||||||
different ways (absolute/relative).
|
different ways (absolute/relative).
|
||||||
* #1111: Fix failure to find uppercase words in search when
|
* #1111: Fix failure to find uppercase words in search when
|
||||||
:confval:`html_search_language` is 'ja'. Thanks to Tomo Saito.
|
`html_search_language` is 'ja'. Thanks to Tomo Saito.
|
||||||
* #1108: The text writer now correctly numbers enumerated lists with
|
* #1108: The text writer now correctly numbers enumerated lists with
|
||||||
non-default start values (based on patch by Ewan Edwards).
|
non-default start values (based on patch by Ewan Edwards).
|
||||||
* #1102: Support multi-context "with" statements in autodoc.
|
* #1102: Support multi-context "with" statements in autodoc.
|
||||||
@ -809,7 +809,7 @@ Release 1.1.3 (Mar 10, 2012)
|
|||||||
* #860: Do not crash when encountering invalid doctest examples, just
|
* #860: Do not crash when encountering invalid doctest examples, just
|
||||||
emit a warning.
|
emit a warning.
|
||||||
|
|
||||||
* #864: Fix crash with some settings of :confval:`modindex_common_prefix`.
|
* #864: Fix crash with some settings of `modindex_common_prefix`.
|
||||||
|
|
||||||
* #862: Fix handling of ``-D`` and ``-A`` options on Python 3.
|
* #862: Fix handling of ``-D`` and ``-A`` options on Python 3.
|
||||||
|
|
||||||
@ -873,7 +873,7 @@ Release 1.1 (Oct 9, 2011)
|
|||||||
Incompatible changes
|
Incompatible changes
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
* The :rst:dir:`py:module` directive doesn't output its ``platform`` option
|
* The `py:module` directive doesn't output its ``platform`` option
|
||||||
value anymore. (It was the only thing that the directive did output, and
|
value anymore. (It was the only thing that the directive did output, and
|
||||||
therefore quite inconsistent.)
|
therefore quite inconsistent.)
|
||||||
|
|
||||||
@ -909,7 +909,7 @@ Features added
|
|||||||
:rst:dir:`toctree`\'s ``numbered`` option.
|
:rst:dir:`toctree`\'s ``numbered`` option.
|
||||||
- #586: Implemented improved :rst:dir:`glossary` markup which allows
|
- #586: Implemented improved :rst:dir:`glossary` markup which allows
|
||||||
multiple terms per definition.
|
multiple terms per definition.
|
||||||
- #478: Added :rst:dir:`py:decorator` directive to describe decorators.
|
- #478: Added `py:decorator` directive to describe decorators.
|
||||||
- C++ domain now supports array definitions.
|
- C++ domain now supports array definitions.
|
||||||
- C++ domain now supports doc fields (``:param x:`` inside directives).
|
- C++ domain now supports doc fields (``:param x:`` inside directives).
|
||||||
- Section headings in :rst:dir:`only` directives are now correctly
|
- Section headings in :rst:dir:`only` directives are now correctly
|
||||||
@ -920,7 +920,7 @@ Features added
|
|||||||
* HTML builder:
|
* HTML builder:
|
||||||
|
|
||||||
- Added ``pyramid`` theme.
|
- Added ``pyramid`` theme.
|
||||||
- #559: :confval:`html_add_permalinks` is now a string giving the
|
- #559: `html_add_permalinks` is now a string giving the
|
||||||
text to display in permalinks.
|
text to display in permalinks.
|
||||||
- #259: HTML table rows now have even/odd CSS classes to enable
|
- #259: HTML table rows now have even/odd CSS classes to enable
|
||||||
"Zebra styling".
|
"Zebra styling".
|
||||||
@ -928,26 +928,26 @@ Features added
|
|||||||
|
|
||||||
* Other builders:
|
* Other builders:
|
||||||
|
|
||||||
- #516: Added new value of the :confval:`latex_show_urls` option to
|
- #516: Added new value of the `latex_show_urls` option to
|
||||||
show the URLs in footnotes.
|
show the URLs in footnotes.
|
||||||
- #209: Added :confval:`text_newlines` and :confval:`text_sectionchars`
|
- #209: Added `text_newlines` and `text_sectionchars`
|
||||||
config values.
|
config values.
|
||||||
- Added :confval:`man_show_urls` config value.
|
- Added `man_show_urls` config value.
|
||||||
- #472: linkcheck builder: Check links in parallel, use HTTP HEAD
|
- #472: linkcheck builder: Check links in parallel, use HTTP HEAD
|
||||||
requests and allow configuring the timeout. New config values:
|
requests and allow configuring the timeout. New config values:
|
||||||
:confval:`linkcheck_timeout` and :confval:`linkcheck_workers`.
|
`linkcheck_timeout` and `linkcheck_workers`.
|
||||||
- #521: Added :confval:`linkcheck_ignore` config value.
|
- #521: Added `linkcheck_ignore` config value.
|
||||||
- #28: Support row/colspans in tables in the LaTeX builder.
|
- #28: Support row/colspans in tables in the LaTeX builder.
|
||||||
|
|
||||||
* Configuration and extensibility:
|
* Configuration and extensibility:
|
||||||
|
|
||||||
- #537: Added :confval:`nitpick_ignore`.
|
- #537: Added `nitpick_ignore`.
|
||||||
- #306: Added :event:`env-get-outdated` event.
|
- #306: Added :event:`env-get-outdated` event.
|
||||||
- :meth:`.Application.add_stylesheet` now accepts full URIs.
|
- :meth:`.Application.add_stylesheet` now accepts full URIs.
|
||||||
|
|
||||||
* Autodoc:
|
* Autodoc:
|
||||||
|
|
||||||
- #564: Add :confval:`autodoc_docstring_signature`. When enabled (the
|
- #564: Add `autodoc_docstring_signature`. When enabled (the
|
||||||
default), autodoc retrieves the signature from the first line of the
|
default), autodoc retrieves the signature from the first line of the
|
||||||
docstring, if it is found there.
|
docstring, if it is found there.
|
||||||
- #176: Provide ``private-members`` option for autodoc directives.
|
- #176: Provide ``private-members`` option for autodoc directives.
|
||||||
@ -965,12 +965,12 @@ Features added
|
|||||||
- Added ``inline`` option to graphviz directives, and fixed the
|
- Added ``inline`` option to graphviz directives, and fixed the
|
||||||
default (block-style) in LaTeX output.
|
default (block-style) in LaTeX output.
|
||||||
- #590: Added ``caption`` option to graphviz directives.
|
- #590: Added ``caption`` option to graphviz directives.
|
||||||
- #553: Added :rst:dir:`testcleanup` blocks in the doctest extension.
|
- #553: Added `testcleanup` blocks in the doctest extension.
|
||||||
- #594: :confval:`trim_doctest_flags` now also removes ``<BLANKLINE>``
|
- #594: `trim_doctest_flags` now also removes ``<BLANKLINE>``
|
||||||
indicators.
|
indicators.
|
||||||
- #367: Added automatic exclusion of hidden members in inheritance
|
- #367: Added automatic exclusion of hidden members in inheritance
|
||||||
diagrams, and an option to selectively enable it.
|
diagrams, and an option to selectively enable it.
|
||||||
- Added :confval:`pngmath_add_tooltips`.
|
- Added `pngmath_add_tooltips`.
|
||||||
- The math extension displaymath directives now support ``name`` in
|
- The math extension displaymath directives now support ``name`` in
|
||||||
addition to ``label`` for giving the equation label, for compatibility
|
addition to ``label`` for giving the equation label, for compatibility
|
||||||
with Docutils.
|
with Docutils.
|
||||||
@ -1043,7 +1043,7 @@ Release 1.0.8 (Sep 23, 2011)
|
|||||||
* #669: Respect the ``noindex`` flag option in py:module directives.
|
* #669: Respect the ``noindex`` flag option in py:module directives.
|
||||||
|
|
||||||
* #675: Fix IndexErrors when including nonexisting lines with
|
* #675: Fix IndexErrors when including nonexisting lines with
|
||||||
:rst:dir:`literalinclude`.
|
`literalinclude`.
|
||||||
|
|
||||||
* #676: Respect custom function/method parameter separator strings.
|
* #676: Respect custom function/method parameter separator strings.
|
||||||
|
|
||||||
@ -1126,7 +1126,7 @@ Release 1.0.6 (Jan 04, 2011)
|
|||||||
* #570: Try decoding ``-D`` and ``-A`` command-line arguments with
|
* #570: Try decoding ``-D`` and ``-A`` command-line arguments with
|
||||||
the locale's preferred encoding.
|
the locale's preferred encoding.
|
||||||
|
|
||||||
* #528: Observe :confval:`locale_dirs` when looking for the JS
|
* #528: Observe `locale_dirs` when looking for the JS
|
||||||
translations file.
|
translations file.
|
||||||
|
|
||||||
* #574: Add special code for better support of Japanese documents
|
* #574: Add special code for better support of Japanese documents
|
||||||
@ -1299,51 +1299,51 @@ Features added
|
|||||||
|
|
||||||
- Added a "nitpicky" mode that emits warnings for all missing
|
- Added a "nitpicky" mode that emits warnings for all missing
|
||||||
references. It is activated by the :option:`-n` command-line switch
|
references. It is activated by the :option:`-n` command-line switch
|
||||||
or the :confval:`nitpicky` config value.
|
or the `nitpicky` config value.
|
||||||
- Added ``latexpdf`` target in quickstart Makefile.
|
- Added ``latexpdf`` target in quickstart Makefile.
|
||||||
|
|
||||||
* Markup:
|
* Markup:
|
||||||
|
|
||||||
- The :rst:role:`menuselection` and :rst:role:`guilabel` roles now
|
- The `menuselection` and `guilabel` roles now
|
||||||
support ampersand accelerators.
|
support ampersand accelerators.
|
||||||
- New more compact doc field syntax is now recognized: ``:param type
|
- New more compact doc field syntax is now recognized: ``:param type
|
||||||
name: description``.
|
name: description``.
|
||||||
- Added ``tab-width`` option to :rst:dir:`literalinclude` directive.
|
- Added ``tab-width`` option to `literalinclude` directive.
|
||||||
- Added ``titlesonly`` option to :rst:dir:`toctree` directive.
|
- Added ``titlesonly`` option to :rst:dir:`toctree` directive.
|
||||||
- Added the ``prepend`` and ``append`` options to the
|
- Added the ``prepend`` and ``append`` options to the
|
||||||
:rst:dir:`literalinclude` directive.
|
`literalinclude` directive.
|
||||||
- #284: All docinfo metadata is now put into the document metadata, not
|
- #284: All docinfo metadata is now put into the document metadata, not
|
||||||
just the author.
|
just the author.
|
||||||
- The :rst:role:`ref` role can now also reference tables by caption.
|
- The `ref` role can now also reference tables by caption.
|
||||||
- The :rst:dir:`include` directive now supports absolute paths, which
|
- The :dudir:`include` directive now supports absolute paths, which
|
||||||
are interpreted as relative to the source directory.
|
are interpreted as relative to the source directory.
|
||||||
- In the Python domain, references like ``:func:`.name``` now look for
|
- In the Python domain, references like ``:func:`.name``` now look for
|
||||||
matching names with any prefix if no direct match is found.
|
matching names with any prefix if no direct match is found.
|
||||||
|
|
||||||
* Configuration:
|
* Configuration:
|
||||||
|
|
||||||
- Added :confval:`rst_prolog` config value.
|
- Added `rst_prolog` config value.
|
||||||
- Added :confval:`html_secnumber_suffix` config value to control
|
- Added `html_secnumber_suffix` config value to control
|
||||||
section numbering format.
|
section numbering format.
|
||||||
- Added :confval:`html_compact_lists` config value to control
|
- Added `html_compact_lists` config value to control
|
||||||
docutils' compact lists feature.
|
docutils' compact lists feature.
|
||||||
- The :confval:`html_sidebars` config value can now contain patterns
|
- The `html_sidebars` config value can now contain patterns
|
||||||
as keys, and the values can be lists that explicitly select which
|
as keys, and the values can be lists that explicitly select which
|
||||||
sidebar templates should be rendered. That means that the builtin
|
sidebar templates should be rendered. That means that the builtin
|
||||||
sidebar contents can be included only selectively.
|
sidebar contents can be included only selectively.
|
||||||
- :confval:`html_static_path` can now contain single file entries.
|
- `html_static_path` can now contain single file entries.
|
||||||
- The new universal config value :confval:`exclude_patterns` makes the
|
- The new universal config value `exclude_patterns` makes the
|
||||||
old :confval:`unused_docs`, :confval:`exclude_trees` and
|
old ``unused_docs``, ``exclude_trees`` and
|
||||||
:confval:`exclude_dirnames` obsolete.
|
``exclude_dirnames`` obsolete.
|
||||||
- Added :confval:`html_output_encoding` config value.
|
- Added `html_output_encoding` config value.
|
||||||
- Added the :confval:`latex_docclass` config value and made the
|
- Added the `latex_docclass` config value and made the
|
||||||
"twoside" documentclass option overridable by "oneside".
|
"twoside" documentclass option overridable by "oneside".
|
||||||
- Added the :confval:`trim_doctest_flags` config value, which is true
|
- Added the `trim_doctest_flags` config value, which is true
|
||||||
by default.
|
by default.
|
||||||
- Added :confval:`html_show_copyright` config value.
|
- Added `html_show_copyright` config value.
|
||||||
- Added :confval:`latex_show_pagerefs` and :confval:`latex_show_urls`
|
- Added `latex_show_pagerefs` and `latex_show_urls`
|
||||||
config values.
|
config values.
|
||||||
- The behavior of :confval:`html_file_suffix` changed slightly: the
|
- The behavior of `html_file_suffix` changed slightly: the
|
||||||
empty string now means "no suffix" instead of "default suffix", use
|
empty string now means "no suffix" instead of "default suffix", use
|
||||||
``None`` for "default suffix".
|
``None`` for "default suffix".
|
||||||
|
|
||||||
@ -1385,7 +1385,7 @@ Features added
|
|||||||
* Extension API:
|
* Extension API:
|
||||||
|
|
||||||
- Added :event:`html-collect-pages`.
|
- Added :event:`html-collect-pages`.
|
||||||
- Added :confval:`needs_sphinx` config value and
|
- Added `needs_sphinx` config value and
|
||||||
:meth:`~sphinx.application.Sphinx.require_sphinx` application API
|
:meth:`~sphinx.application.Sphinx.require_sphinx` application API
|
||||||
method.
|
method.
|
||||||
- #200: Added :meth:`~sphinx.application.Sphinx.add_stylesheet`
|
- #200: Added :meth:`~sphinx.application.Sphinx.add_stylesheet`
|
||||||
@ -1397,7 +1397,7 @@ Features added
|
|||||||
- Added the :mod:`~sphinx.ext.extlinks` extension.
|
- Added the :mod:`~sphinx.ext.extlinks` extension.
|
||||||
- Added support for source ordering of members in autodoc, with
|
- Added support for source ordering of members in autodoc, with
|
||||||
``autodoc_member_order = 'bysource'``.
|
``autodoc_member_order = 'bysource'``.
|
||||||
- Added :confval:`autodoc_default_flags` config value, which can be
|
- Added `autodoc_default_flags` config value, which can be
|
||||||
used to select default flags for all autodoc directives.
|
used to select default flags for all autodoc directives.
|
||||||
- Added a way for intersphinx to refer to named labels in other
|
- Added a way for intersphinx to refer to named labels in other
|
||||||
projects, and to specify the project you want to link to.
|
projects, and to specify the project you want to link to.
|
||||||
@ -1407,7 +1407,7 @@ Features added
|
|||||||
extension, thanks to Pauli Virtanen.
|
extension, thanks to Pauli Virtanen.
|
||||||
- #309: The :mod:`~sphinx.ext.graphviz` extension can now output SVG
|
- #309: The :mod:`~sphinx.ext.graphviz` extension can now output SVG
|
||||||
instead of PNG images, controlled by the
|
instead of PNG images, controlled by the
|
||||||
:confval:`graphviz_output_format` config value.
|
`graphviz_output_format` config value.
|
||||||
- Added ``alt`` option to :rst:dir:`graphviz` extension directives.
|
- Added ``alt`` option to :rst:dir:`graphviz` extension directives.
|
||||||
- Added ``exclude`` argument to :func:`.autodoc.between`.
|
- Added ``exclude`` argument to :func:`.autodoc.between`.
|
||||||
|
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
:tocdepth: 2
|
:tocdepth: 2
|
||||||
|
|
||||||
|
.. default-role:: any
|
||||||
|
|
||||||
.. _changes:
|
.. _changes:
|
||||||
|
|
||||||
Changes in Sphinx
|
Changes in Sphinx
|
||||||
|
@ -36,7 +36,11 @@ installed) and handled in a smart way:
|
|||||||
highlighted as Python).
|
highlighted as Python).
|
||||||
|
|
||||||
* The highlighting language can be changed using the ``highlight`` directive,
|
* The highlighting language can be changed using the ``highlight`` directive,
|
||||||
used as follows::
|
used as follows:
|
||||||
|
|
||||||
|
.. rst:directive:: .. highlight:: language
|
||||||
|
|
||||||
|
Example::
|
||||||
|
|
||||||
.. highlight:: c
|
.. highlight:: c
|
||||||
|
|
||||||
@ -44,7 +48,11 @@ installed) and handled in a smart way:
|
|||||||
|
|
||||||
* For documents that have to show snippets in different languages, there's also
|
* For documents that have to show snippets in different languages, there's also
|
||||||
a :rst:dir:`code-block` directive that is given the highlighting language
|
a :rst:dir:`code-block` directive that is given the highlighting language
|
||||||
directly::
|
directly:
|
||||||
|
|
||||||
|
.. rst:directive:: .. code-block:: language
|
||||||
|
|
||||||
|
Use it like this::
|
||||||
|
|
||||||
.. code-block:: ruby
|
.. code-block:: ruby
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user