Changelog

3.1.0

Removed cap on acceptable versions for sphinx-autodoc-typehints. However, because sphinx-toolbox customises some of the functions from that package, configuration options added after version 1.14.1 may not work (e.g. typehints_defaults and typehints_formatter).

Bugs Fixed

3.0.0

Additions

Removals

Bugs Fixed

2.18.2

Bugs Fixed

2.18.0

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

2.17.0

Bugs Fixed

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

Additions

2.15.3

Features

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

Bugs Fixed

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

2.15.1

Bugs Fixed

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

Bugs Fixed


Note

The changlog prior to 2.13.0 has not been compiled yet.