Changelog¶

2.14.1¶

Bugs Fixed¶

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 True and False

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.