Sourced from black's releases.
23.10.1
Highlights
- Maintanence release to get a fix out for GitHub Action edge case (#3957)
Preview style
- Fix merging implicit multiline strings that have inline comments (#3956)
- Allow empty first line after block open before a comment or compound statement (#3967)
Packaging
- Change Dockerfile to hatch + compile black (#3965)
Integrations
- The summary output for GitHub workflows is now suppressible using the
summary
parameter. (#3958)- Fix the action failing when Black check doesn't pass (#3957)
Documentation
- It is known Windows documentation CI is broken psf/black#3968
23.10.0
Stable style
- Fix comments getting removed from inside parenthesized strings (#3909)
Preview style
- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)
Configuration
- Fix cache versioning logic when
BLACK_CACHE_DIR
is set (#3937)Parser
... (truncated)
Sourced from black's changelog.
23.10.1
Highlights
- Maintanence release to get a fix out for GitHub Action edge case (#3957)
Preview style
- Fix merging implicit multiline strings that have inline comments (#3956)
- Allow empty first line after block open before a comment or compound statement (#3967)
Packaging
- Change Dockerfile to hatch + compile black (#3965)
Integrations
- The summary output for GitHub workflows is now suppressible using the
summary
parameter. (#3958)- Fix the action failing when Black check doesn't pass (#3957)
Documentation
- It is known Windows documentation CI is broken psf/black#3968
23.10.0
Stable style
- Fix comments getting removed from inside parenthesized strings (#3909)
Preview style
- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)
Configuration
- Fix cache versioning logic when
BLACK_CACHE_DIR
is set (#3937)Parser
- Fix bug where attributes named
type
were not accepted insidematch
statements (#3950)- Add support for PEP 695 type aliases containing lambdas and other unusual expressions
... (truncated)
744d23b
Prepare release 23.10.1 (#3969)8de4be5
Fix CI failing (#3957)c0adca3
docs: specifies the use of the .git-blame-ignore-revs file (#3961)a7643fa
Add summary parameter to action (#3958)d291c23
Move Docker image to hatch + compile (#3965)7f1c578
Bump peter-evans/create-or-update-comment from 3.0.2 to 3.1.0 (#3966)2db5ab0
Allow empty line after block open before a comment or compound statement (#3967)0a37888
Fix typos in CHANGES.md (#3963)882d879
Fix merging implicit multiline strings that have inline comments (#3956)9edba85
Prepare release 23.10.0 (#3951)Sourced from black's releases.
23.10.0
Stable style
- Fix comments getting removed from inside parenthesized strings (#3909)
Preview style
- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)
Configuration
- Fix cache versioning logic when
BLACK_CACHE_DIR
is set (#3937)Parser
- Fix bug where attributes named
type
were not acccepted insidematch
statements (#3950)- Add support for PEP 695 type aliases containing lambdas and other unusual expressions (#3949)
Output
- Black no longer attempts to provide special errors for attempting to format Python 2 code (#3933)
- Black will more consistently print stacktraces on internal errors in verbose mode (#3938)
Integrations
- The action output displayed in the job summary is now wrapped in Markdown (#3914)
Sourced from black's changelog.
23.10.0
Stable style
- Fix comments getting removed from inside parenthesized strings (#3909)
Preview style
- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)
Configuration
- Fix cache versioning logic when
BLACK_CACHE_DIR
is set (#3937)Parser
- Fix bug where attributes named
type
were not acccepted insidematch
statements (#3950)- Add support for PEP 695 type aliases containing lambdas and other unusual expressions (#3949)
Output
- Black no longer attempts to provide special errors for attempting to format Python 2 code (#3933)
- Black will more consistently print stacktraces on internal errors in verbose mode (#3938)
Integrations
- The action output displayed in the job summary is now wrapped in Markdown (#3914)
9edba85
Prepare release 23.10.0 (#3951)bb58807
Fix parser bug where "type" was misinterpreted as a keyword inside a match (#...722735d
Fix grammar for type alias support (#3949)abe57e3
Treat raw strings like other docstrings (#3947)1648ac5
Fix long lines with power operator(s) getting splitted before line length (#3...6f84f65
Migrate mypy config to pyproject.toml (#3936)3bb9214
CI Test: Deprecating 'Healthcheck.all()' from Hypothesis in fuzz.py (#3945)935f303
Fix test that was not being run (#3939)b7717c3
Standardise newlines after module-level docstrings (#3932)7aa37ea
Report all stacktraces in verbose mode (#3938)Sourced from sphinx's releases.
Sphinx 7.2.6
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from furo's changelog.
Changelog
2023.09.10 -- Zesty Zaffre
- Make asset hash injection idempotent, fixing Sphinx 6 compatibility.
- Fix the check for HTML builders, fixing non-HTML Read the Docs builds.
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@âAA-Turner
!- Bump
require_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- âš Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
... (truncated)
2718ca4
Prepare release: 2023.09.10c22c99d
Update changelogc37e849
Quote a not-runtime-generic type annotation9cfdf44
Rework infrastructure for linting5abeb9f
Fix the check for HTML buildersee2ab54
Tweak how tests are run with noxcdae236
Test against Sphinx minor versions in CI9e40071
Make asset hash injection idempotentaab86f4
Revert "Exclude incompatible Sphinx releases (#711)"4dd6eec
Exclude incompatible Sphinx releases (#711)Sourced from black's releases.
23.9.1
Due to various issues, the previous release (23.9.0) did not include compiled mypyc wheels, which make Black significantly faster. These issues have now been fixed, and this release should come with compiled wheels once again.
There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12 wheels in a future release as soon as the mypyc bug is fixed.
Packaging
- Upgrade to mypy 1.5.1 (#3864)
Performance
- Store raw tuples instead of NamedTuples in Black's cache, improving performance and decreasing the size of the cache (#3877)
23.9.0
Preview style
- More concise formatting for dummy implementations (#3796)
- In stub files, add a blank line between a statement with a body (e.g an
if sys.version_info > (3, x):
) and a function definition on the same level (#3862)- Fix a bug whereby spaces were removed from walrus operators within subscript(#3823)
Configuration
- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
Performance
- Avoid importing
IPython
if notebook cells do not contain magics (#3782)- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
Blackd
- Fix an issue in
blackd
with single character input (#3558)Integrations
- Black now has an official pre-commit mirror. Swapping
https://github.com/psf/black
tohttps://github.com/psf/black-pre-commit-mirror
in your.pre-commit-config.yaml
will make Black about 2x faster (#3828)- The
.black.env
folder specified byENV_PATH
will now be removed on the completion of the GitHub Action (#3759)
Sourced from black's changelog.
23.9.1
Due to various issues, the previous release (23.9.0) did not include compiled mypyc wheels, which make Black significantly faster. These issues have now been fixed, and this release should come with compiled wheels once again.
There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12 wheels in a future release as soon as the mypyc bug is fixed.
Packaging
- Upgrade to mypy 1.5.1 (#3864)
Performance
- Store raw tuples instead of NamedTuples in Black's cache, improving performance and decreasing the size of the cache (#3877)
23.9.0
Preview style
- More concise formatting for dummy implementations (#3796)
- In stub files, add a blank line between a statement with a body (e.g an
if sys.version_info > (3, x):
) and a function definition on the same level (#3862)- Fix a bug whereby spaces were removed from walrus operators within subscript(#3823)
Configuration
- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
Performance
- Avoid importing
IPython
if notebook cells do not contain magics (#3782)- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
Blackd
- Fix an issue in
blackd
with single character input (#3558)Integrations
- Black now has an official pre-commit mirror. Swapping
https://github.com/psf/black
tohttps://github.com/psf/black-pre-commit-mirror
in your.pre-commit-config.yaml
will make Black about 2x faster (#3828)- The
.black.env
folder specified byENV_PATH
will now be removed on the completion of the GitHub Action (#3759)
e877371
Prepare release 23.9.1 (#3878)62dca32
mypyc builds on PRs, skip mypyc wheels for 3.12 (#3870)751583a
Pickle raw tuples in FileData cache (#3877)f791745
Re-export black.Mode (#3875)0b62b9c
Ignore aiohttp DeprecationWarning for 3.12 (#3876)c83ad6c
Upgrade to Furo 2023.9.10 to fix docs build (#3873)4eebfd1
Add mypyc test marks to new tests that patch (#3871)add161b
Bump RTD Python version from 3.8 to 3.11 (#3868)4e93f2a
Add classifier for 3.12 (#3866)716fa08
Upgrade mypy (#3864)Sourced from furo's changelog.
Changelog
2023.09.10 -- Zesty Zaffre
- Make asset hash injection idempotent, fixing Sphinx 6 compatibility.
- Fix the check for HTML builders, fixing non-HTML Read the Docs builds.
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@âAA-Turner
!- Bump
require_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- âš Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
... (truncated)
2718ca4
Prepare release: 2023.09.10c22c99d
Update changelogc37e849
Quote a not-runtime-generic type annotation9cfdf44
Rework infrastructure for linting5abeb9f
Fix the check for HTML buildersee2ab54
Tweak how tests are run with noxcdae236
Test against Sphinx minor versions in CI9e40071
Make asset hash injection idempotentaab86f4
Revert "Exclude incompatible Sphinx releases (#711)"4dd6eec
Exclude incompatible Sphinx releases (#711)Sourced from black's releases.
23.9.1
Due to various issues, the previous release (23.9.0) did not include compiled mypyc wheels, which make Black significantly faster. These issues have now been fixed, and this release should come with compiled wheels once again.
There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12 wheels in a future release as soon as the mypyc bug is fixed.
Packaging
- Upgrade to mypy 1.5.1 (#3864)
Performance
- Store raw tuples instead of NamedTuples in Black's cache, improving performance and decreasing the size of the cache (#3877)
23.9.0
Preview style
- More concise formatting for dummy implementations (#3796)
- In stub files, add a blank line between a statement with a body (e.g an
if sys.version_info > (3, x):
) and a function definition on the same level (#3862)- Fix a bug whereby spaces were removed from walrus operators within subscript(#3823)
Configuration
- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
Performance
- Avoid importing
IPython
if notebook cells do not contain magics (#3782)- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
Blackd
- Fix an issue in
blackd
with single character input (#3558)Integrations
- Black now has an official pre-commit mirror. Swapping
https://github.com/psf/black
tohttps://github.com/psf/black-pre-commit-mirror
in your.pre-commit-config.yaml
will make Black about 2x faster (#3828)- The
.black.env
folder specified byENV_PATH
will now be removed on the completion of the GitHub Action (#3759)
Sourced from black's changelog.
23.9.1
Due to various issues, the previous release (23.9.0) did not include compiled mypyc wheels, which make Black significantly faster. These issues have now been fixed, and this release should come with compiled wheels once again.
There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12 wheels in a future release as soon as the mypyc bug is fixed.
Packaging
- Upgrade to mypy 1.5.1 (#3864)
Performance
- Store raw tuples instead of NamedTuples in Black's cache, improving performance and decreasing the size of the cache (#3877)
23.9.0
Preview style
- More concise formatting for dummy implementations (#3796)
- In stub files, add a blank line between a statement with a body (e.g an
if sys.version_info > (3, x):
) and a function definition on the same level (#3862)- Fix a bug whereby spaces were removed from walrus operators within subscript(#3823)
Configuration
- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
Performance
- Avoid importing
IPython
if notebook cells do not contain magics (#3782)- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
Blackd
- Fix an issue in
blackd
with single character input (#3558)Integrations
- Black now has an official pre-commit mirror. Swapping
https://github.com/psf/black
tohttps://github.com/psf/black-pre-commit-mirror
in your.pre-commit-config.yaml
will make Black about 2x faster (#3828)- The
.black.env
folder specified byENV_PATH
will now be removed on the completion of the GitHub Action (#3759)
e877371
Prepare release 23.9.1 (#3878)62dca32
mypyc builds on PRs, skip mypyc wheels for 3.12 (#3870)751583a
Pickle raw tuples in FileData cache (#3877)f791745
Re-export black.Mode (#3875)0b62b9c
Ignore aiohttp DeprecationWarning for 3.12 (#3876)c83ad6c
Upgrade to Furo 2023.9.10 to fix docs build (#3873)4eebfd1
Add mypyc test marks to new tests that patch (#3871)add161b
Bump RTD Python version from 3.8 to 3.11 (#3868)4e93f2a
Add classifier for 3.12 (#3866)716fa08
Upgrade mypy (#3864)Sourced from sphinx's releases.
Sphinx 7.2.5
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.5 (released Aug 30, 2023)
Bugs fixed
- #11645: Fix a regression preventing autodoc from importing modules within packages that make use of
if typing.TYPE_CHECKING:
to guard circular imports needed by type checkers. Patch by Matt Wozniski.- #11634: Fixed inheritance diagram relative link resolution for sibling files in a subdirectory. Patch by Albert Shih.
- #11659: Allow
?config=...
in :confval:mathjax_path
.- #11654: autodoc: Fail with a more descriptive error message when an object claims to be an instance of
type
, but is not a class. Patch by James Braza.- 11620: Cease emitting :event:
source-read
events for files read via the :dudir:include
directive.- 11620: Add a new :event:
include-read
for observing and transforming the content of included files via the :dudir:include
directive.- #11627: Restore support for copyright lines of the form
YYYY
whenSOURCE_DATE_EPOCH
is set.
fcc3899
Bump to 7.2.5 final2a631f9
Restore support for YYYY copyright lines2730cc3
Remove double spaces in CHANGESff18318
Add an 'include-read'
event (#11657)74329d9
Fail better in ExceptionDocumenter.can_document_member
(#11660)7d046a8
Allow ?config=...
in mathjax_path
(#11659)4692208
Fix two relative link bugs in inheritance diagrams (#11634)ca0fc7a
Add git .mailmap file8248be3
autodoc: Reset sys.modules
on partial import failure (#11645)e494baa
Recommend correct replacement names for deprecated APIs (#11655)Sourced from sphinx's releases.
Sphinx 7.2.4
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.4 (released Aug 28, 2023)
Bugs fixed
- #11618: Fix a regression in the MoveModuleTargets transform, introduced in #10478 (#9662).
- #11649: linkcheck: Resolve hanging tests for timezones west of London and incorrect conversion from UTC to offsets from the UNIX epoch. Patch by Dmitry Shachnev and Adam Turner.
Release 7.2.3 (released Aug 23, 2023)
Dependencies
- #11576: Require sphinxcontrib-serializinghtml 1.1.9.
Bugs fixed
- Fix regression in
autodoc.Documenter.parse_name()
.- Fix regression in JSON serialisation.
- #11543: autodoc: Support positional-only parameters in
classmethod
methods whenautodoc_preserve_defaults
isTrue
.- Restore support string methods on path objects. This is deprecated and will be removed in Sphinx 8. Use :py:func:
os.fspath
to convert :py:class:~pathlib.Path
objects to strings, or :py:class:~pathlib.Path
's methods to work with path objects.Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()
patch, for when calling with keyword arguments.- Fixed membership testing (
in
) for the :py:class:str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree
,includehidden
may be passed as a string or a boolean.- Fix
:noindex:
forPyModule
andJSModule
.Release 7.2.1 (released Aug 17, 2023)
... (truncated)
3256f1f
Bump to 7.2.4 final2f025a4
linkcheck: Fix conversion from UTC time to the UNIX epoch (#11649)1567281
autodoc: Fix UnboundLocalError in filter_members
(#11651)5e88b9f
Fix the MoveModuleTargets transform (#11647)694fcee
Fix markup in CHANGES (#11639)c503c90
Improve pathlib
type annotations (#11646)bf339b1
Bump version2f6ea14
Bump to 7.2.3 final511e407
Implement bool()
for string paths494de73
Implement hash()
for string pathsSourced from furo's changelog.
Changelog
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@âAA-Turner
!- Bump
require_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- âš Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
... (truncated)
0766bb2
Prepare release: 2023.08.19807d73c
Update changelog364b261
Accomodate for the required data-content_root
for search0d38bc6
Simplify retrieval of pygments_dark_style
value (#699)3631ffc
Use sphinx.errors.ConfigError
(#697)d2e2448
Remove duplicate HTML builder check (#698)7b4f130
Drop Python 3.7 (#701)e322b71
Remove pointless assert (#702)ee2097a
Bump require_sphinx()
to Sphinx 6.0 (#700)c1ff10b
Back to developmentSourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for âfiles have been formattedâ.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()
patch, for when calling with keyword arguments.- Fixed membership testing (
in
) for the :py:class:str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree
,includehidden
may be passed as a string or a boolean.- Fix
:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
Bugs fixed
- Restored the the :py:class:
str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon. This will be removed in Sphinx 9.- Restored calls to
Builder.add_{css,js}_file()
, which several extensions relied upon.- Restored the private API
TocTree.get_toctree_ancestors()
, which several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
- #11512: Deprecate
sphinx.util.md5
andsphinx.util.sha1
. Usehashlib
instead.- #11526: Deprecate
sphinx.testing.path
. Useos.path
orpathlib
instead.- #11528: Deprecate
sphinx.util.split_index_msg
andsphinx.util.split_into
. Usesphinx.util.index_entries.split_index_msg
instead.- Deprecate
sphinx.builders.html.Stylesheet
andsphinx.builders.html.Javascript
. Usesphinx.application.Sphinx.add_css_file()
... (truncated)
ed84d63
Bump to 7.2.2 finalea4a73e
[bot]: Update message catalogues (#11612)e47846a
Fix :noindex:
for PyModule
and JSModule``b2fc47f
Add CHANGES entry for renaming the StateMachine.insert_input()
parameter0835c3e
Fix regression in SingleFileHTMLBuilder._get_local_toctree
49dc0dd
Fix asset class string interface membership testing8512855
Fix signature of docutils include_source monkeypatch (#11610)e1d9068
Bump version441a9e4
Bump to 7.2.1 finalec31853
Restore TocTree.get_toctree_ancestors()
Sourced from furo's changelog.
Changelog
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@âAA-Turner
!- Bump
require_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- âš Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
... (truncated)
0766bb2
Prepare release: 2023.08.19807d73c
Update changelog364b261
Accomodate for the required data-content_root
for search0d38bc6
Simplify retrieval of pygments_dark_style
value (#699)3631ffc
Use sphinx.errors.ConfigError
(#697)d2e2448
Remove duplicate HTML builder check (#698)7b4f130
Drop Python 3.7 (#701)e322b71
Remove pointless assert (#702)ee2097a
Bump require_sphinx()
to Sphinx 6.0 (#700)c1ff10b
Back to developmentSourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for âfiles have been formattedâ.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.3 (released Aug 23, 2023)
Dependencies
- #11576: Require sphinxcontrib-serializinghtml 1.1.9.
Bugs fixed
- Fix regression in
autodoc.Documenter.parse_name()
.- Fix regression in JSON serialisation.
- #11543: autodoc: Support positional-only parameters in
classmethod
methods whenautodoc_preserve_defaults
isTrue
.- Restore support string methods on path objects. This is deprecated and will be removed in Sphinx 8. Use :py:func
os.fspath
to convert :py:class:pathlib.Path
objects to strings, or :py:class:pathlib.Path
's methods to work with path objects.Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()
patch, for when calling with keyword arguments.- Fixed membership testing (
in
) for the :py:class:str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree
,includehidden
may be passed as a string or a boolean.- Fix
:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
Bugs fixed
- Restored the the :py:class:
str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon. This will be removed in Sphinx 9.- Restored calls to
Builder.add_{css,js}_file()
, which several extensions relied upon.- Restored the private API
TocTree.get_toctree_ancestors()
, which several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
... (truncated)
2f6ea14
Bump to 7.2.3 final511e407
Implement bool()
for string paths494de73
Implement hash()
for string paths2986aa1
Override special methods for string paths07b87e9
Update CHANGES for 7.2.36b17dd1
Support string methods on path objects (#11619)a73fb59
Support positional-only parameters in classmethods (#11635)02cb02c
Fix invocation of python -m sphinx build
6183b6a
Require sphinxcontrib-serializinghtml 1.1.9 or later1e16f21
Fix regression in autodoc.Documenter.parse_name
(#11613)Sourced from furo's changelog.
Changelog
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@âAA-Turner
!- Bump
require_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- âš Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
... (truncated)
0766bb2
Prepare release: 2023.08.19807d73c
Update changelog364b261
Accomodate for the required data-content_root
for search0d38bc6
Simplify retrieval of pygments_dark_style
value (#699)3631ffc
Use sphinx.errors.ConfigError
(#697)d2e2448
Remove duplicate HTML builder check (#698)7b4f130
Drop Python 3.7 (#701)e322b71
Remove pointless assert (#702)ee2097a
Bump require_sphinx()
to Sphinx 6.0 (#700)c1ff10b
Back to developmentSourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for âfiles have been formattedâ.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()
patch, for when calling with keyword arguments.- Fixed membership testing (
in
) for the :py:class:str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree
,includehidden
may be passed as a string or a boolean.- Fix
:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
Bugs fixed
- Restored the the :py:class:
str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon. This will be removed in Sphinx 9.- Restored calls to
Builder.add_{css,js}_file()
, which several extensions relied upon.- Restored the private API
TocTree.get_toctree_ancestors()
, which several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
- #11512: Deprecate
sphinx.util.md5
andsphinx.util.sha1
. Usehashlib
instead.- #11526: Deprecate
sphinx.testing.path
. Useos.path
orpathlib
instead.- #11528: Deprecate
sphinx.util.split_index_msg
andsphinx.util.split_into
. Usesphinx.util.index_entries.split_index_msg
instead.- Deprecate
sphinx.builders.html.Stylesheet
andsphinx.builders.html.Javascript
. Usesphinx.application.Sphinx.add_css_file()
... (truncated)
ed84d63
Bump to 7.2.2 finalea4a73e
[bot]: Update message catalogues (#11612)e47846a
Fix :noindex:
for PyModule
and JSModule``b2fc47f
Add CHANGES entry for renaming the StateMachine.insert_input()
parameter0835c3e
Fix regression in SingleFileHTMLBuilder._get_local_toctree
49dc0dd
Fix asset class string interface membership testing8512855
Fix signature of docutils include_source monkeypatch (#11610)e1d9068
Bump version441a9e4
Bump to 7.2.1 finalec31853
Restore TocTree.get_toctree_ancestors()
Sourced from furo's changelog.
Changelog
2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- âš Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- âš Add support for Sphinx 6.
- âš Improve footnote presentation with docutils 0.18+.
... (truncated)
Sourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for âfiles have been formattedâ.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
- #11512: Deprecate
sphinx.util.md5
andsphinx.util.sha1
. Usehashlib
instead.- #11526: Deprecate
sphinx.testing.path
. Useos.path
orpathlib
instead.- #11528: Deprecate
sphinx.util.split_index_msg
andsphinx.util.split_into
. Usesphinx.util.index_entries.split_index_msg
instead.- Deprecate
sphinx.builders.html.Stylesheet
andsphinx.builders.html.Javascript
. Usesphinx.application.Sphinx.add_css_file()
andsphinx.application.Sphinx.add_js_file()
instead.- #11582: Deprecate
sphinx.builders.html.StandaloneHTMLBuilder.css_files
andsphinx.builders.html.StandaloneHTMLBuilder.script_files
. Usesphinx.application.Sphinx.add_css_file()
andsphinx.application.Sphinx.add_js_file()
instead.- #11459: Deprecate
sphinx.ext.autodoc.preserve_defaults.get_function_def()
. Patch by Bénédikt Tran.Features added
- #11526: Support
os.PathLike
types andpathlib.Path
objects in many more places.- #5474: coverage: Print summary statistics tables. Patch by Jorge Leitao.
- #6319: viewcode: Add :confval:
viewcode_line_numbers
to control whether line numbers are added to rendered source code. Patch by Ben Krikler.- #9662: Add the
:no-typesetting:
option to suppress textual output and only create a linkable anchor. Patch by Latosha Maltba.- #11221: C++: Support domain objects in the table of contents. Patch by Rouslan Korneychuk.
- #10938: doctest: Add :confval:
doctest_show_successes
option. Patch by Trey Hunner.- #11533: Add
:no-index:
,:no-index-entry:
, and:no-contents-entry:
.- #11572: Improve
debug
logging of reasons why files are detected as out of date. Patch by Eric Larson.
... (truncated)
da9f8a5
Bump to 7.2.0 final794324a
Declare support for Python 3.1303bceac
[bot]: Update message catalogues (#11538)aecebce
Make _resolve_toctree()
keyword-only76658c4
Fix sphinx.ext.autodoc.preserve_defaults
(#11550)4dee162
Fix layout issues in the agogo theme for smaller viewports (#11594)4ddbee4
Fix console_scripts
entry points4add50a
Remove unneeded type annotation9d8ef83
Fix test_inspect_main_noargs
ddf8a8e
Add CHANGES entry for GH-11533Sourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for âfiles have been formattedâ.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for âfiles have been formattedâ.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.2 (released Aug 02, 2023)
Bugs fixed
- #11542: linkcheck: Properly respect :confval:
linkcheck_anchors
and do not spuriously report failures to validate anchors. Patch by James Addison.Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
- #11514: Fix
SOURCE_DATE_EPOCH
in multi-line copyright footer. Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module
,keyword
,operator
,object
,exception
,statement
, andbuiltin
) in the :rst:dir:index
directive, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinx
now allows the version requirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_length
and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list
.
... (truncated)
320d0b6
Bump to 7.1.2 final06c1339
Ensure that linkcheck_anchors
is properly respected (#11544)89808c6
Emend attribution for GH-11431 in CHANGES (#11547)4958d2a
Fix flake8 E231 reported linting failure4862da8
Bump versiond8d73c1
Bump to 7.1.1 finala54e630
[internationalisation] Update message catalogues8452300
Fix multi-line copyright when SOURCE_DATE_EPOCH
is set (#11524)fe08cec
bump versione560f63
Bump to 7.1.0 finalSourced from furo's changelog.
Changelog
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- âš Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- âš Add support for Sphinx 6.
- âš Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
... (truncated)
35f5307
Prepare release: 2023.07.260a8bedc
Update changeloga92dd0c
Make _add_asset_hashes
a no-op with Sphinx 7.1f8db95b
Improve literals with inline code are handled1680dbe
Document the use of figclass
with figure
directivebeebd7e
Increase the specificity of the admonition title selector834e951
Setup uploads to Percy27bf2c0
[pre-commit.ci] pre-commit autoupdate (#672)c8b51d0
Fix how content overflow is handled80afa27
[pre-commit.ci] pre-commit autoupdate (#652)2e74dc4
Version 1.15.08ddb2f1
[pre-commit.ci] pre-commit autoupdate (#257)64fbca6
Drop Python 3.7 support (#256)f6a0817
[pre-commit.ci] pre-commit autoupdate (#255)cbdcb50
[pre-commit.ci] pre-commit autoupdate (#254)37fc70e
Upgrade requirements (#253)7bbe434
[pre-commit.ci] pre-commit autoupdate (#250)Sourced from sphinx's releases.
Sphinx 7.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.2 (released Aug 02, 2023)
Bugs fixed
- #11542: linkcheck: Properly respect :confval:
linkcheck_anchors
and do not spuriously report failures to validate anchors. Patch by James Addison.Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
- #11514: Fix
SOURCE_DATE_EPOCH
in multi-line copyright footer. Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module
,keyword
,operator
,object
,exception
,statement
, andbuiltin
) in the :rst:dir:index
directive, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinx
now allows the version requirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_length
and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list
.
... (truncated)
320d0b6
Bump to 7.1.2 final06c1339
Ensure that linkcheck_anchors
is properly respected (#11544)89808c6
Emend attribution for GH-11431 in CHANGES (#11547)4958d2a
Fix flake8 E231 reported linting failure4862da8
Bump versiond8d73c1
Bump to 7.1.1 finala54e630
[internationalisation] Update message catalogues8452300
Fix multi-line copyright when SOURCE_DATE_EPOCH
is set (#11524)fe08cec
bump versione560f63
Bump to 7.1.0 finalSourced from furo's changelog.
Changelog
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- âš Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- âš Add support for Sphinx 6.
- âš Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
... (truncated)
35f5307
Prepare release: 2023.07.260a8bedc
Update changeloga92dd0c
Make _add_asset_hashes
a no-op with Sphinx 7.1f8db95b
Improve literals with inline code are handled1680dbe
Document the use of figclass
with figure
directivebeebd7e
Increase the specificity of the admonition title selector834e951
Setup uploads to Percy27bf2c0
[pre-commit.ci] pre-commit autoupdate (#672)c8b51d0
Fix how content overflow is handled80afa27
[pre-commit.ci] pre-commit autoupdate (#652)2e74dc4
Version 1.15.08ddb2f1
[pre-commit.ci] pre-commit autoupdate (#257)64fbca6
Drop Python 3.7 support (#256)f6a0817
[pre-commit.ci] pre-commit autoupdate (#255)cbdcb50
[pre-commit.ci] pre-commit autoupdate (#254)37fc70e
Upgrade requirements (#253)7bbe434
[pre-commit.ci] pre-commit autoupdate (#250)Sourced from sphinx's releases.
Sphinx 7.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
- #11514: Fix
SOURCE_DATE_EPOCH
in multi-line copyright footer. Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module
,keyword
,operator
,object
,exception
,statement
, andbuiltin
) in the :rst:dir:index
directive, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinx
now allows the version requirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_length
and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list
. Patch by Thomas Louf, Adam Turner, and Jean-François B.- #10983: Support for multiline copyright statements in the footer block. Patch by Stefanie Molin
sphinx.util.display.status_iterator
now clears the current line with ANSI control codes, rather than overprinting with space characters.- #11431: linkcheck: Treat SSL failures as broken links. Patch by Bénédikt Tran
- #11157: Keep the
translated
attribute on translated nodes.- #11451: Improve the traceback displayed when using :option:
sphinx-build -T
in parallel builds. Patch by Bénédikt Tran
... (truncated)
d8d73c1
Bump to 7.1.1 finala54e630
[internationalisation] Update message catalogues8452300
Fix multi-line copyright when SOURCE_DATE_EPOCH
is set (#11524)fe08cec
bump versione560f63
Bump to 7.1.0 final066e0fa
Add translation progress information (#11509)0882914
Target PyPI in create-release.yml21fbee5
Fix OIDC token payload1a403e4
Add informational log messaging258b0ea
Revert "Switch to using github.request
"Sourced from sphinx's releases.
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module
,keyword
,operator
,object
,exception
,statement
, andbuiltin
) in the :rst:dir:index
directive, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinx
now allows the version requirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_length
and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list
. Patch by Thomas Louf, Adam Turner, and Jean-François B.- #10983: Support for multiline copyright statements in the footer block. Patch by Stefanie Molin
sphinx.util.display.status_iterator
now clears the current line with ANSI control codes, rather than overprinting with space characters.- #11431: linkcheck: Treat SSL failures as broken links. Patch by Bénédikt Tran
- #11157: Keep the
translated
attribute on translated nodes.- #11451: Improve the traceback displayed when using :option:
sphinx-build -T
in parallel builds. Patch by Bénédikt Tran- #11324: linkcheck: Use session-basd HTTP requests.
- #11438: Add support for the :rst:dir:
py:class
and :rst:dir:py:function
directives for PEP 695 (generic classes and functions declarations) and PEP 696 (default type parameters). Multi-line support (#11011) is enabled for type parameters list and can be locally controlled on object description directives, e.g., :rst:dir:py:function:single-line-type-parameter-list
. Patch by Bénédikt Tran.- #11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis via :confval:
linkcheck_anchors_ignore_for_url
while
... (truncated)
e560f63
Bump to 7.1.0 final066e0fa
Add translation progress information (#11509)0882914
Target PyPI in create-release.yml21fbee5
Fix OIDC token payload1a403e4
Add informational log messaging258b0ea
Revert "Switch to using github.request
"f9c89e5
Switch to using github.request
52c7f66
Use the correct token minting URL for TestPyPI6079f28
Install twine in PyPI publish workflow3d43b9e
Fix github-script syntax in create-release.ymlSourced from furo's changelog.
Changelog
2023.05.20 -- Unassuming Ultramarine
- âš Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- âš Add support for Sphinx 6.
- âš Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
- Replace the
meta
generator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
... (truncated)
d2c9ca8
Prepare release: 2023.05.20662d21b
Update changelog591780b
Bump compatible Sphinx versionc2e7837
Bump NodeJS and package versionsdd85574
Use the reference HtmlFormatter class defined on PygmentsBridge. (#657)6bff419
Fix broken link (#654)e7f732e
Improve the screen-reader label for sidebar collapse48c0bf2
Drop the check for the theme name1b17d81
[pre-commit.ci] pre-commit autoupdate (#646)4904fd5
Remove Python 3.8 constraint from Black pre-commit config (#647)