Skip to content

Latest commit

 

History

History
193 lines (125 loc) · 6.47 KB

changelog.rst

File metadata and controls

193 lines (125 loc) · 6.47 KB
Raw

Changelog

3.0.0 (Unreleased)

Additions

  • Official support for Sphinx 4.5 and docutils 0.17
  • sphinx_toolbox.collapse -- Added the :open: option for having the collapsable section open by default. Suggested by :githubtdegeus in :github96. (PR :github101)
  • sphinx_toolbox.more_autosummary.column_widths -- Allows for the autosummary table column widths to be customised with the LaTeX builder. (PR :github100)
  • sphinx_toolbox.tweaks.latex_layout -- Added the needspace_amount option for configuring the LaTeX needspace extension.
  • Add sphinx_toolbox.latex.succinct_seealso and make sphinx_toolbox.latex a package.
  • Add :rstnamedtuple-field role for cross-references to namedtuple fields. (PR :github104)

Moves

  • sphinx_toolbox.tweaks.latex_layout -- Moved to sphinx_toolbox.latex.layout.
  • sphinx_toolbox.tweaks.latex_toc -- Moved to sphinx_toolbox.latex.toc.

Removals

  • Python 3.6 (including CPython 3.6 and PyPy 3.6) are no longer supported. (PR :github99)
  • sphinx_toolbox.issues -- IssueNode, visit_issue_node, depart_issue_node, get_issue_title. Import from sphinx_toolbox.github.issues instead.
  • sphinx_toolbox.tweaks.sphinx_panels_tabs.copy_assets -- renamed to ~sphinx_toolbox.tweaks.sphinx_panels_tabs.copy_asset_files.
  • sphinx_toolbox.utils.begin_generate

Bugs Fixed

  • sphinx_toolbox.more_autodoc.overloads -- Now try to resolve forward references in function overloads.
  • sphinx_toolbox.confval -- :rstconfval directives now show up in the index.
  • :rstautonamedtuple, :rstautoprotocol, :rstautotypeddict -- Index entries are now created. (PR :github103)
  • Type hints for typing.ContextManager redirect to contextlib.AbstractContextManager on Python 3.7 and 3.8.

2.18.2

Bugs Fixed

  • sphinx_toolbox.github now correctly parses issue titles containing code and quote characters. Reported by :githubarisp99 in :github91.
  • sphinx_toolbox.more_autosummary -- Restore compatibility with latest autodocsumm. For the time being autodocsumm's relative_ref_paths option is not supported.

2.18.0

consolekit is no longer a dependency; ~.TerminalRegexParser now contains the necessary code to create coloured text itself.

2.17.0

Additions

  • sphinx_toolbox.testing.latex_regression and sphinx_toolbox.testing.LaTeXRegressionFixture
  • The jinja2_namespace argument to sphinx_toolbox.testing.HTMLRegressionFixture.check

Bugs Fixed

  • Close the underlying requests session of sphinx_toolbox.utils.GITHUB_COM when the Python interpreter exits.
  • sphinx_toolbox.more_autodoc.typehints.process_docstring is skipped for variable and regex documenters where there aren't :param: and :rtype: attributes.

2.16.1

Removed top-end requirement for Sphinx. The officially supported versions are Sphinx 3.2 to 4.4 inclusive.

2.16.0

Bugs Fixed

  • sphinx_toolbox.more_autodoc -- Ensure the |nbsp| substitution is set up correctly when the rst_prolog option is specified in conf.py (Issue 80). when using the extension on its own.
  • Set the class CSS class with custom autodocumenters (~.autonamedtuple, ~.autoprotocol and ~.autotypeddict) (Issue 79)

Additions

  • sphinx_toolbox.utils.add_fallback_css_class
  • sphinx_toolbox.testing.HTMLRegressionFixture -- made the docutils_version variable available in jinja2 templates.

2.15.3

Features

  • Support sphinx-autodoc-typehints versions 1.12-1.14.

Bugs Fixed

  • sphinx_toolbox.more_autodoc.regex -- Ensure the |nbsp| substitution is set up when using the extension on its own (Issue 80).

Deprecations

  • sphinx_toolbox.utils.begin_generate -- Will be removed in v3.0.0. Users of this function should reimplement it in their own code.

2.15.2

Bugs Fixed

  • sphinx_toolbox.decorators -- Ensure the deco role correctly finds the targets of xrefs.

2.15.1

Bugs Fixed

  • sphinx_toolbox.github -- fix crash when getting GitHub issue titles if there's no internet.

2.15.0

Features

  • Added support for Sphinx 4.1 and 4.2
  • Added support for autodocsumm > 0.2.2
  • Improved support for Python 3.10.0 rc.2

Bugs Fixed

  • ~.RegexDocumenter -- No longer outputs a csv-table directive when there is no pattern and no flags. This prevents docutils emitting a warning.
  • Correctly uses UTF-8 when reading files in HTML regression tests.

2.14.0

Features

  • sphinx_toolbox.testing.HTMLRegressionFixture -- Added support for rendering the reference file as a jinja2 template, which can be used to account for differences between Python and Sphinx versions.
  • Added support for Sphinx 4.0 and sphinx-tabs versions up to 3.2.0
  • Improved support for Python 3.10.0 rc.1
  • sphinx_toolbox.tweaks.latex_layout -- Now configures hyperref to use correct page numbering for the frontmatter.

Bugs Fixed

  • URLs pointing to https://pypistats.org/ now use lowercased project names.
  • The cls and return attributes are ignored from __annotations__ when deciding whether to include the __new__ method for a ~.NamedTuple with ~.NamedTupleDocumenter.

2.13.0

Features

  • Added support for Sphinx 3.4.x and 3.5.x.
  • sphinx_toolbox.more_autodoc.autoprotocol -- Added support for generic bases, such as class SupportsAbs(Protocol[T_co]): ....
  • sphinx_toolbox.more_autosummary -- Added the autosummary_col_type configuration option.
  • sphinx_toolbox.latex.replace_unknown_unicode -- Add support for converting ≥ and ≤.
  • sphinx_toolbox.more_autodoc.typehints.format_annotation -- Added support for :pyTrue and :pyFalse

Bugs Fixed

  • sphinx_toolbox.more_autosummary -- Ensure __all__ is respected for autosummary tables.

Note

The changlog prior to 2.13.0 has not been compiled yet.