diff --git a/CHANGES b/CHANGES index 885766608..b87a844f5 100644 --- a/CHANGES +++ b/CHANGES @@ -836,7 +836,7 @@ Features added * #9672: More CSS classes on Python domain descriptions * #9695: More CSS classes on Javascript domain descriptions * #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 interphinx resolution of cross-references that do not have an explicit inventory specification. Specific types of cross-references can be disabled, @@ -1690,7 +1690,7 @@ Release 3.3.1 (released Nov 12, 2020) 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 without __init__.py * #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 typehints as object description if ``autodoc_typehints = "description"`` set. 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 visitor/departure method for original node class not found * #6418: Add new event: :event:`object-description-transform` @@ -2799,7 +2799,7 @@ Incompatible changes * #4550: html: Centering tables by default using CSS * #6239: latex: xelatex and xeCJK are used for Chinese documents by default * ``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 ---------- @@ -3991,7 +3991,7 @@ Deprecated * ``format_annotation()`` and ``formatargspec()`` is deprecated. Please use ``sphinx.util.inspect.Signature`` instead. * ``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 deprecated. Please use ``app.add_autodocumenter()`` instead. * ``AutoDirective._special_attrgetters`` is now deprecated. Please use @@ -4207,7 +4207,7 @@ Bugs fixed * #4281: Race conditions when creating output directory * #4315: For PDF 'howto' documents, ``latex_toplevel_sectioning='part'`` 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) * #4091: Private members not documented without :undoc-members: @@ -4603,7 +4603,7 @@ Deprecated * #3221: epub2 builder is deprecated * #3254: ``sphinx.websupport`` is now separated into independent package; ``sphinxcontrib-websupport``. ``sphinx.websupport`` will be removed in - Sphinx-2.0. + Sphinx 2.0. * #3628: ``sphinx_themes`` entry_point is deprecated. Please use ``sphinx.html_themes`` instead. @@ -4898,7 +4898,7 @@ Incompatible changes Deprecated ---------- -These features are removed in Sphinx-1.6: +These features are removed in Sphinx 1.6: * LDML format support in i18n feature * ``sphinx.addnodes.termsep`` @@ -5247,7 +5247,7 @@ Bugs fixed namespaces. * latex, images (from image directive) in lists or quoted blocks did not obey 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 * #2731: `sphinx.ext.autodoc` does not access propertymethods which raises any exceptions @@ -5407,7 +5407,7 @@ Incompatible changes * 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 - backward compatibility until Sphinx-1.5. + backward compatibility until Sphinx 1.5. Translations ------------ @@ -5473,8 +5473,8 @@ Incompatible changes `_ like ``"MMMM dd, YYYY"`` is default format for `today_fmt` and `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 - disabled from Sphinx-1.5. + supported for backward compatibility until Sphinx 1.5. Later format will be + disabled from Sphinx 1.5. * #2327: ``latex_use_parts`` is deprecated now. Use `latex_toplevel_sectioning` instead. * #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. * #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 - 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 Hirai. * #1780, #1866: "make text" shows "class" keyword twice. Thanks to Takayuki @@ -5804,7 +5804,7 @@ Bugs fixed node.astext() during docutils transforming. * #1989: "make blahblah" on Windows indicate help messages for sphinx-build 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 u prefixed config value for 'version' and 'release'. * #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 develop builder extensions. Thanks to Takeshi Komiya. * #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 python-mecab is not installed. * #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. * #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 directive or currentclass directive. * #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. * #1544: ``make text`` generates wrong table when it has empty table cells. * #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. ex. ``python setup.py build_sphinx -b doctest`` return zero even if doctest failed. diff --git a/doc/extdev/markupapi.rst b/doc/extdev/markupapi.rst index 8fc884d7c..332e5b1f9 100644 --- a/doc/extdev/markupapi.rst +++ b/doc/extdev/markupapi.rst @@ -138,8 +138,8 @@ Both APIs parse the content into a given node. They are used like this:: .. deprecated:: 1.7 - Until Sphinx-1.6, ``sphinx.ext.autodoc.AutodocReporter`` is used for this - purpose. For now, it is replaced by ``switch_source_input()``. + Until Sphinx 1.6, ``sphinx.ext.autodoc.AutodocReporter`` was used for this + purpose. It is replaced by ``switch_source_input()``. If you don't need the wrapping node, you can use any concrete node type and return ``node.children`` from the Directive. diff --git a/doc/usage/builders/index.rst b/doc/usage/builders/index.rst index 45a83c678..ce2c5dce0 100644 --- a/doc/usage/builders/index.rst +++ b/doc/usage/builders/index.rst @@ -159,8 +159,7 @@ The builder's "name" must be given to the **-b** command-line option of .. versionchanged:: 1.5 - Since Sphinx-1.5, the epub3 builder is used for the default builder of - epub. + Since Sphinx 1.5, the epub3 builder is used as the default epub builder. .. module:: sphinx.builders.latex .. class:: LaTeXBuilder @@ -438,7 +437,7 @@ name is ``rinoh``. Refer to the `rinohtype manual`_ for details. .. 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