Changelog¶
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.
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 thedeco
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 acsv-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 configureshyperref
to use correct page numbering for the frontmatter.
Bugs Fixed¶
URLs pointing to https://pypistats.org/ now use lowercased project names.
The
cls
andreturn
attributes are ignored from__annotations__
when deciding whether to include the__new__
method for aNamedTuple
withNamedTupleDocumenter
.
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 asclass SupportsAbs(Protocol[T_co]): ...
.sphinx_toolbox.more_autosummary
– Added theautosummary_col_type
configuration option.sphinx_toolbox.latex.replace_unknown_unicode()
– Add support for converting≥
and≤
.sphinx_toolbox.more_autodoc.typehints.format_annotation()
– Added support forTrue
andFalse
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.