IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Normalise spelling of Sphinx versions

Browse Source
This commit is contained in:
Adam Turner 2023-01-08 19:28:40 +00:00
parent 97f07ca83c
commit f5c957597d
3 changed files with 21 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CHANGES
View File

@ -836,7 +836,7 @@ Features added
* #9672: More CSS classes on Python domain descriptions * #9672: More CSS classes on Python domain descriptions
* #9695: More CSS classes on Javascript domain descriptions * #9695: More CSS classes on Javascript domain descriptions
* #9683: Revert the removal of ``add_stylesheet()`` API. It will be kept until * #9683: Revert the removal of ``add_stylesheet()`` API. It will be kept until
the Sphinx-6.0 release the Sphinx 6.0 release
* #2068, add :confval:`intersphinx_disabled_reftypes` for disabling * #2068, add :confval:`intersphinx_disabled_reftypes` for disabling
interphinx resolution of cross-references that do not have an explicit interphinx resolution of cross-references that do not have an explicit
inventory specification. Specific types of cross-references can be disabled, inventory specification. Specific types of cross-references can be disabled,
@ -1690,7 +1690,7 @@ Release 3.3.1 (released Nov 12, 2020)
Bugs fixed Bugs fixed
---------- ----------
* #8372: autodoc: autoclass directive became slower than Sphinx-3.2 * #8372: autodoc: autoclass directive became slower than Sphinx 3.2
* #7727: autosummary: raise PycodeError when documenting python package * #7727: autosummary: raise PycodeError when documenting python package
without __init__.py without __init__.py
* #8350: autosummary: autosummary_mock_imports causes slow down builds * #8350: autosummary: autosummary_mock_imports causes slow down builds
@ -2504,7 +2504,7 @@ Features added
* #6418: autodoc: Add a new extension ``sphinx.ext.autodoc.typehints``. It shows * #6418: autodoc: Add a new extension ``sphinx.ext.autodoc.typehints``. It shows
typehints as object description if ``autodoc_typehints = "description"`` set. typehints as object description if ``autodoc_typehints = "description"`` set.
This is an experimental extension and it will be integrated into autodoc core This is an experimental extension and it will be integrated into autodoc core
in Sphinx-3.0 in Sphinx 3.0
* SphinxTranslator now calls visitor/departure method for super node class if * SphinxTranslator now calls visitor/departure method for super node class if
visitor/departure method for original node class not found visitor/departure method for original node class not found
* #6418: Add new event: :event:`object-description-transform` * #6418: Add new event: :event:`object-description-transform`
@ -2799,7 +2799,7 @@ Incompatible changes
* #4550: html: Centering tables by default using CSS * #4550: html: Centering tables by default using CSS
* #6239: latex: xelatex and xeCJK are used for Chinese documents by default * #6239: latex: xelatex and xeCJK are used for Chinese documents by default
* ``Sphinx.add_lexer()`` now takes a Lexer class instead of instance. An * ``Sphinx.add_lexer()`` now takes a Lexer class instead of instance. An
instance of lexers are still supported until Sphinx-3.x. instance of lexers are still supported until Sphinx 3.x.
Deprecated Deprecated
---------- ----------
@ -3991,7 +3991,7 @@ Deprecated
* ``format_annotation()`` and ``formatargspec()`` is deprecated. Please use * ``format_annotation()`` and ``formatargspec()`` is deprecated. Please use
``sphinx.util.inspect.Signature`` instead. ``sphinx.util.inspect.Signature`` instead.
* ``sphinx.ext.autodoc.AutodocReporter`` is replaced by ``sphinx.util.docutils. * ``sphinx.ext.autodoc.AutodocReporter`` is replaced by ``sphinx.util.docutils.
switch_source_input()`` and now deprecated. It will be removed in Sphinx-2.0. switch_source_input()`` and now deprecated. It will be removed in Sphinx 2.0.
* ``sphinx.ext.autodoc.add_documenter()`` and ``AutoDirective._register`` is now * ``sphinx.ext.autodoc.add_documenter()`` and ``AutoDirective._register`` is now
deprecated. Please use ``app.add_autodocumenter()`` instead. deprecated. Please use ``app.add_autodocumenter()`` instead.
* ``AutoDirective._special_attrgetters`` is now deprecated. Please use * ``AutoDirective._special_attrgetters`` is now deprecated. Please use
@ -4207,7 +4207,7 @@ Bugs fixed
* #4281: Race conditions when creating output directory * #4281: Race conditions when creating output directory
* #4315: For PDF 'howto' documents, ``latex_toplevel_sectioning='part'`` * #4315: For PDF 'howto' documents, ``latex_toplevel_sectioning='part'``
generates ``\chapter`` commands generates ``\chapter`` commands
* #4214: Two todolist directives break sphinx-1.6.5 * #4214: Two todolist directives break Sphinx 1.6.5
* Fix links to external option docs with intersphinx (refs: #3769) * Fix links to external option docs with intersphinx (refs: #3769)
* #4091: Private members not documented without :undoc-members: * #4091: Private members not documented without :undoc-members:
@ -4603,7 +4603,7 @@ Deprecated
* #3221: epub2 builder is deprecated * #3221: epub2 builder is deprecated
* #3254: ``sphinx.websupport`` is now separated into independent package; * #3254: ``sphinx.websupport`` is now separated into independent package;
``sphinxcontrib-websupport``. ``sphinx.websupport`` will be removed in ``sphinxcontrib-websupport``. ``sphinx.websupport`` will be removed in
Sphinx-2.0. Sphinx 2.0.
* #3628: ``sphinx_themes`` entry_point is deprecated. Please use * #3628: ``sphinx_themes`` entry_point is deprecated. Please use
``sphinx.html_themes`` instead. ``sphinx.html_themes`` instead.
@ -4898,7 +4898,7 @@ Incompatible changes
Deprecated Deprecated
---------- ----------
These features are removed in Sphinx-1.6: These features are removed in Sphinx 1.6:
* LDML format support in i18n feature * LDML format support in i18n feature
* ``sphinx.addnodes.termsep`` * ``sphinx.addnodes.termsep``
@ -5247,7 +5247,7 @@ Bugs fixed
namespaces. namespaces.
* latex, images (from image directive) in lists or quoted blocks did not obey * latex, images (from image directive) in lists or quoted blocks did not obey
indentation (fixed together with #2671) indentation (fixed together with #2671)
* #2733: since Sphinx-1.4.4 ``make latexpdf`` generates lots of hyperref * #2733: since Sphinx 1.4.4 ``make latexpdf`` generates lots of hyperref
warnings warnings
* #2731: `sphinx.ext.autodoc` does not access propertymethods which raises any * #2731: `sphinx.ext.autodoc` does not access propertymethods which raises any
exceptions exceptions
@ -5407,7 +5407,7 @@ Incompatible changes
* The default format of `today_fmt` and `html_last_updated_fmt` is back to * The default format of `today_fmt` and `html_last_updated_fmt` is back to
strftime format again. Locale Date Markup Language is also supported for strftime format again. Locale Date Markup Language is also supported for
backward compatibility until Sphinx-1.5. backward compatibility until Sphinx 1.5.
Translations Translations
------------ ------------
@ -5473,8 +5473,8 @@ Incompatible changes
<https://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns>`_ like <https://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns>`_ like
``"MMMM dd, YYYY"`` is default format for `today_fmt` and ``"MMMM dd, YYYY"`` is default format for `today_fmt` and
`html_last_updated_fmt`. However strftime format like ``"%B %d, %Y"`` is also `html_last_updated_fmt`. However strftime format like ``"%B %d, %Y"`` is also
supported for backward compatibility until Sphinx-1.5. Later format will be supported for backward compatibility until Sphinx 1.5. Later format will be
disabled from Sphinx-1.5. disabled from Sphinx 1.5.
* #2327: ``latex_use_parts`` is deprecated now. Use `latex_toplevel_sectioning` * #2327: ``latex_use_parts`` is deprecated now. Use `latex_toplevel_sectioning`
instead. instead.
* #2337: Use ``\url{URL}`` macro instead of ``\href{URL}{URL}`` in LaTeX writer. * #2337: Use ``\url{URL}`` macro instead of ``\href{URL}{URL}`` in LaTeX writer.
@ -5771,7 +5771,7 @@ Bugs fixed
* Fix a crash when setting up extensions which do not support metadata. * Fix a crash when setting up extensions which do not support metadata.
* #1784: Provide non-minified JS code in ``sphinx/search/non-minified-js/*.js`` * #1784: Provide non-minified JS code in ``sphinx/search/non-minified-js/*.js``
* #1822, #1892: Fix regression for #1061. autosummary can't generate doc for * #1822, #1892: Fix regression for #1061. autosummary can't generate doc for
imported members since sphinx-1.3b3. Thanks to Eric Larson. imported members since Sphinx 1.3b3. Thanks to Eric Larson.
* #1793, #1819: "see also" misses a linebreak in text output. Thanks to Takayuki * #1793, #1819: "see also" misses a linebreak in text output. Thanks to Takayuki
Hirai. Hirai.
* #1780, #1866: "make text" shows "class" keyword twice. Thanks to Takayuki * #1780, #1866: "make text" shows "class" keyword twice. Thanks to Takayuki
@ -5804,7 +5804,7 @@ Bugs fixed
node.astext() during docutils transforming. node.astext() during docutils transforming.
* #1989: "make blahblah" on Windows indicate help messages for sphinx-build * #1989: "make blahblah" on Windows indicate help messages for sphinx-build
every time. It was caused by wrong make.bat that generated by every time. It was caused by wrong make.bat that generated by
Sphinx-1.3.0/1.3.1. Sphinx 1.3.0/1.3.1.
* On Py2 environment, conf.py that is generated by sphinx-quickstart should have * On Py2 environment, conf.py that is generated by sphinx-quickstart should have
u prefixed config value for 'version' and 'release'. u prefixed config value for 'version' and 'release'.
* #2102: On Windows + Py3, using ``|today|`` and non-ASCII date format will * #2102: On Windows + Py3, using ``|today|`` and non-ASCII date format will
@ -6177,7 +6177,7 @@ Bugs fixed
* PR#297, #1571: Add imgpath property to all builders. It make easier to * PR#297, #1571: Add imgpath property to all builders. It make easier to
develop builder extensions. Thanks to Takeshi Komiya. develop builder extensions. Thanks to Takeshi Komiya.
* #1584: Point to master doc in HTML "top" link. * #1584: Point to master doc in HTML "top" link.
* #1585: Autosummary of modules broken in Sphinx-1.2.3. * #1585: Autosummary of modules broken in Sphinx 1.2.3.
* #1610: Sphinx cause AttributeError when MeCab search option is enabled and * #1610: Sphinx cause AttributeError when MeCab search option is enabled and
python-mecab is not installed. python-mecab is not installed.
* #1674: Do not crash if a module's ``__all__`` is not a list of strings. * #1674: Do not crash if a module's ``__all__`` is not a list of strings.
@ -6206,7 +6206,7 @@ Bugs fixed
* #636: Keep straight single quotes in literal blocks in the LaTeX build. * #636: Keep straight single quotes in literal blocks in the LaTeX build.
* #1419: Generated i18n sphinx.js files are missing message catalog entries * #1419: Generated i18n sphinx.js files are missing message catalog entries
from '.js_t' and '.html'. The issue was introduced from Sphinx-1.1 from '.js_t' and '.html'. The issue was introduced from Sphinx 1.1
* #1363: Fix i18n: missing python domain's cross-references with currentmodule * #1363: Fix i18n: missing python domain's cross-references with currentmodule
directive or currentclass directive. directive or currentclass directive.
* #1444: autosummary does not create the description from attributes docstring. * #1444: autosummary does not create the description from attributes docstring.
@ -6234,7 +6234,7 @@ Bugs fixed
* #1477: gettext does not extract nodes.line in a table or list. * #1477: gettext does not extract nodes.line in a table or list.
* #1544: ``make text`` generates wrong table when it has empty table cells. * #1544: ``make text`` generates wrong table when it has empty table cells.
* #1522: Footnotes from table get displayed twice in LaTeX. This problem has * #1522: Footnotes from table get displayed twice in LaTeX. This problem has
been appeared from Sphinx-1.2.1 by #949. been appeared from Sphinx 1.2.1 by #949.
* #508: Sphinx every time exit with zero when is invoked from setup.py command. * #508: Sphinx every time exit with zero when is invoked from setup.py command.
ex. ``python setup.py build_sphinx -b doctest`` return zero even if doctest ex. ``python setup.py build_sphinx -b doctest`` return zero even if doctest
failed. failed.

4
doc/extdev/markupapi.rst
View File

@ -138,8 +138,8 @@ Both APIs parse the content into a given node. They are used like this::
.. deprecated:: 1.7 .. deprecated:: 1.7
Until Sphinx-1.6, ``sphinx.ext.autodoc.AutodocReporter`` is used for this Until Sphinx 1.6, ``sphinx.ext.autodoc.AutodocReporter`` was used for this
purpose. For now, it is replaced by ``switch_source_input()``. purpose. It is replaced by ``switch_source_input()``.
If you don't need the wrapping node, you can use any concrete node type and If you don't need the wrapping node, you can use any concrete node type and
return ``node.children`` from the Directive. return ``node.children`` from the Directive.

5
doc/usage/builders/index.rst
View File

@ -159,8 +159,7 @@ The builder's "name" must be given to the **-b** command-line option of
.. versionchanged:: 1.5 .. versionchanged:: 1.5
Since Sphinx-1.5, the epub3 builder is used for the default builder of Since Sphinx 1.5, the epub3 builder is used as the default epub builder.
epub.
.. module:: sphinx.builders.latex .. module:: sphinx.builders.latex
.. class:: LaTeXBuilder .. class:: LaTeXBuilder
@ -438,7 +437,7 @@ name is ``rinoh``. Refer to the `rinohtype manual`_ for details.
.. versionchanged:: 1.5 .. versionchanged:: 1.5
Since Sphinx-1.5, the linkcheck builder comes to use requests module. Since Sphinx 1.5, the linkcheck builder uses the requests module.
.. versionchanged:: 3.4 .. versionchanged:: 3.4