Sourced from black's releases.
\n\n\n23.11.0
\nHighlights
\n\n
\n- Support formatting ranges of lines with the new
\n--line-ranges
command-line option\n(#4020)Stable style
\n\n
\n- Fix crash on formatting bytes strings that look like docstrings (#4003)
\n- Fix crash when whitespace followed a backslash before newline in a docstring (#4008)
\n- Fix standalone comments inside complex blocks crashing Black (#4016)
\n- Fix crash on formatting code like
\nawait (a ** b)
(#3994)- No longer treat leading f-strings as docstrings. This matches Python's behaviour and\nfixes a crash (#4019)
\nPreview style
\n\n
\n- Multiline dicts and lists that are the sole argument to a function are now\nindented less (#3964)
\n- Multiline unpacked dicts and lists as the sole argument to a function are now also\nindented less (#3992)
\n- In f-string debug expressions, quote types that are visible in the final string\nare now preserved (#4005)
\n- Fix a bug where long
\ncase
blocks were not split into multiple lines. Also enable\ngeneral trailing comma rules oncase
blocks (#4024)- Keep requiring two empty lines between module-level docstring and first function or\nclass definition (#4028)
\n- Add support for single-line format skip with other comments on the same line (#3959)
\nConfiguration
\n\n
\n- Consistently apply force exclusion logic before resolving symlinks (#4015)
\n- Fix a bug in the matching of absolute path names in
\n--include
(#3976)Performance
\n\n
\n- Fix mypyc builds on arm64 on macOS (#4017)
\nIntegrations
\n\n
\n- Black's pre-commit integration will now run only on git hooks appropriate for a code\nformatter (#3940)
\n23.10.1
\nHighlights
\n\n
\n- Maintanence release to get a fix out for GitHub Action edge case (#3957)
\nPreview style
\n\n
... (truncated)
\nSourced from black's changelog.
\n\n\n23.11.0
\nHighlights
\n\n
\n- Support formatting ranges of lines with the new
\n--line-ranges
command-line option\n(#4020)Stable style
\n\n
\n- Fix crash on formatting bytes strings that look like docstrings (#4003)
\n- Fix crash when whitespace followed a backslash before newline in a docstring (#4008)
\n- Fix standalone comments inside complex blocks crashing Black (#4016)
\n- Fix crash on formatting code like
\nawait (a ** b)
(#3994)- No longer treat leading f-strings as docstrings. This matches Python's behaviour and\nfixes a crash (#4019)
\nPreview style
\n\n
\n- Multiline dicts and lists that are the sole argument to a function are now indented\nless (#3964)
\n- Multiline unpacked dicts and lists as the sole argument to a function are now also\nindented less (#3992)
\n- In f-string debug expressions, quote types that are visible in the final string are\nnow preserved (#4005)
\n- Fix a bug where long
\ncase
blocks were not split into multiple lines. Also enable\ngeneral trailing comma rules oncase
blocks (#4024)- Keep requiring two empty lines between module-level docstring and first function or\nclass definition (#4028)
\n- Add support for single-line format skip with other comments on the same line (#3959)
\nConfiguration
\n\n
\n- Consistently apply force exclusion logic before resolving symlinks (#4015)
\n- Fix a bug in the matching of absolute path names in
\n--include
(#3976)Performance
\n\n
\n- Fix mypyc builds on arm64 on macOS (#4017)
\nIntegrations
\n\n
\n- Black's pre-commit integration will now run only on git hooks appropriate for a code\nformatter (#3940)
\n23.10.1
\nHighlights
\n\n
\n\n- Maintenance release to get a fix out for GitHub Action edge case (#3957)
\n
... (truncated)
\n2a1c67e
Prepare release 23.11.0 (#4032)72e7a2e
Remove redundant condition from has_magic_trailing_comma
(#4023)1a7d9c2
Preserve visible quote types for f-string debug expressions (#4005)f4c7be5
docs: fix minor typo (#4030)2e4fac9
Apply force exclude logic before symlink resolution (#4015)66008fd
[563] Fix standalone comments inside complex blocks crashing Black (#4016)50ed622
Fix long case blocks not split into multiple lines (#4024)46be1f8
Support formatting specified lines (#4020)ecbd9e8
Fix crash with f-string docstrings (#4019)e808e61
Preview: Keep requiring two empty lines between module-level docstring and fi...Sourced from black's releases.
\n\n\n23.10.1
\nHighlights
\n\n
\n- Maintanence release to get a fix out for GitHub Action edge case (#3957)
\nPreview style
\n\n
\n- Fix merging implicit multiline strings that have inline comments (#3956)
\n- Allow empty first line after block open before a comment or compound statement (#3967)
\nPackaging
\n\n
\n- Change Dockerfile to hatch + compile black (#3965)
\nIntegrations
\n\n
\n- The summary output for GitHub workflows is now suppressible using the
\nsummary
\nparameter. (#3958)- Fix the action failing when Black check doesn't pass (#3957)
\nDocumentation
\n\n
\n- It is known Windows documentation CI is broken\npsf/black#3968
\n23.10.0
\nStable style
\n\n
\n- Fix comments getting removed from inside parenthesized strings (#3909)
\nPreview style
\n\n
\n- Fix long lines with power operators getting split before the line length (#3942)
\n- Long type hints are now wrapped in parentheses and properly indented when split across\nmultiple lines (#3899)
\n- Magic trailing commas are now respected in return types. (#3916)
\n- Require one empty line after module-level docstrings. (#3932)
\n- Treat raw triple-quoted strings as docstrings (#3947)
\nConfiguration
\n\n
\n- Fix cache versioning logic when
\nBLACK_CACHE_DIR
is set (#3937)Parser
\n\n\n
... (truncated)
\nSourced from black's changelog.
\n\n\n23.10.1
\nHighlights
\n\n
\n- Maintanence release to get a fix out for GitHub Action edge case (#3957)
\nPreview style
\n\n
\n- Fix merging implicit multiline strings that have inline comments (#3956)
\n- Allow empty first line after block open before a comment or compound statement (#3967)
\nPackaging
\n\n
\n- Change Dockerfile to hatch + compile black (#3965)
\nIntegrations
\n\n
\n- The summary output for GitHub workflows is now suppressible using the
\nsummary
\nparameter. (#3958)- Fix the action failing when Black check doesn't pass (#3957)
\nDocumentation
\n\n
\n- It is known Windows documentation CI is broken\npsf/black#3968
\n23.10.0
\nStable style
\n\n
\n- Fix comments getting removed from inside parenthesized strings (#3909)
\nPreview style
\n\n
\n- Fix long lines with power operators getting split before the line length (#3942)
\n- Long type hints are now wrapped in parentheses and properly indented when split across\nmultiple lines (#3899)
\n- Magic trailing commas are now respected in return types. (#3916)
\n- Require one empty line after module-level docstrings. (#3932)
\n- Treat raw triple-quoted strings as docstrings (#3947)
\nConfiguration
\n\n
\n- Fix cache versioning logic when
\nBLACK_CACHE_DIR
is set (#3937)Parser
\n\n
\n\n- Fix bug where attributes named
\ntype
were not accepted insidematch
statements\n(#3950)- Add support for PEP 695 type aliases containing lambdas and other unusual expressions
\n
... (truncated)
\n744d23b
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.
\n\n\n23.10.0
\nStable style
\n\n
\n- Fix comments getting removed from inside parenthesized strings (#3909)
\nPreview style
\n\n
\n- Fix long lines with power operators getting split before the line length (#3942)
\n- Long type hints are now wrapped in parentheses and properly indented when split across\nmultiple lines (#3899)
\n- Magic trailing commas are now respected in return types. (#3916)
\n- Require one empty line after module-level docstrings. (#3932)
\n- Treat raw triple-quoted strings as docstrings (#3947)
\nConfiguration
\n\n
\n- Fix cache versioning logic when
\nBLACK_CACHE_DIR
is set (#3937)Parser
\n\n
\n- Fix bug where attributes named
\ntype
were not acccepted insidematch
statements\n(#3950)- Add support for PEP 695 type aliases containing lambdas and other unusual expressions\n(#3949)
\nOutput
\n\n
\n- Black no longer attempts to provide special errors for attempting to format Python 2\ncode (#3933)
\n- Black will more consistently print stacktraces on internal errors in verbose mode\n(#3938)
\nIntegrations
\n\n
\n- The action output displayed in the job summary is now wrapped in Markdown (#3914)
\n
Sourced from black's changelog.
\n\n\n23.10.0
\nStable style
\n\n
\n- Fix comments getting removed from inside parenthesized strings (#3909)
\nPreview style
\n\n
\n- Fix long lines with power operators getting split before the line length (#3942)
\n- Long type hints are now wrapped in parentheses and properly indented when split across\nmultiple lines (#3899)
\n- Magic trailing commas are now respected in return types. (#3916)
\n- Require one empty line after module-level docstrings. (#3932)
\n- Treat raw triple-quoted strings as docstrings (#3947)
\nConfiguration
\n\n
\n- Fix cache versioning logic when
\nBLACK_CACHE_DIR
is set (#3937)Parser
\n\n
\n- Fix bug where attributes named
\ntype
were not acccepted insidematch
statements\n(#3950)- Add support for PEP 695 type aliases containing lambdas and other unusual expressions\n(#3949)
\nOutput
\n\n
\n- Black no longer attempts to provide special errors for attempting to format Python 2\ncode (#3933)
\n- Black will more consistently print stacktraces on internal errors in verbose mode\n(#3938)
\nIntegrations
\n\n
\n- The action output displayed in the job summary is now wrapped in Markdown (#3914)
\n
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.
\n\n\nSphinx 7.2.6
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.6 (released Sep 13, 2023)
\nBugs fixed
\n\n
\n- #11679: Add the :envvar:
\n!SPHINX_AUTODOC_RELOAD_MODULES
environment variable,\nwhich if set reloads modules when using autodoc withTYPE_CHECKING = True
.\nPatch by Matt Wozniski and Adam Turner.- #11679: Use :py:func:
\nimportlib.reload
to reload modules in autodoc.\nPatch by Matt Wozniski and Adam Turner.
Sourced from furo's changelog.
\n\n\nChangelog
\n\n2023.09.10 -- Zesty Zaffre
\n\n
\n- Make asset hash injection idempotent, fixing Sphinx 6 compatibility.
\n- Fix the check for HTML builders, fixing non-HTML Read the Docs builds.
\n2023.08.19 -- Xenolithic Xanadu
\n\n
\n- Fix missing search context with Sphinx 7.2, for dirhtml builds.
\n- Drop support for Python 3.7.
\n- Present configuration errors in a better format -- thanks
\n@\u200bAA-Turner
!- Bump
\nrequire_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
\n\n
\n- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
... (truncated)
\n2718ca4
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.
\n\n\n23.9.1
\nDue to various issues, the previous release (23.9.0) did not include compiled mypyc\nwheels, which make Black significantly faster. These issues have now been fixed, and\nthis release should come with compiled wheels once again.
\nThere will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12\nwheels in a future release as soon as the mypyc bug is fixed.
\nPackaging
\n\n
\n- Upgrade to mypy 1.5.1 (#3864)
\nPerformance
\n\n
\n- Store raw tuples instead of NamedTuples in Black's cache, improving performance and\ndecreasing the size of the cache (#3877)
\n23.9.0
\nPreview style
\n\n
\n- More concise formatting for dummy implementations (#3796)
\n- In stub files, add a blank line between a statement with a body (e.g an\n
\nif 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)
\nConfiguration
\n\n
\n- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
\nPerformance
\n\n
\n- Avoid importing
\nIPython
if notebook cells do not contain magics (#3782)- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
\nBlackd
\n\n
\n- Fix an issue in
\nblackd
with single character input (#3558)Integrations
\n\n
\n- Black now has an\nofficial pre-commit mirror. Swapping\n
\nhttps://github.com/psf/black
tohttps://github.com/psf/black-pre-commit-mirror
in\nyour.pre-commit-config.yaml
will make Black about 2x faster (#3828)- The
\n.black.env
folder specified byENV_PATH
will now be removed on the completion\nof the GitHub Action (#3759)
Sourced from black's changelog.
\n\n\n23.9.1
\nDue to various issues, the previous release (23.9.0) did not include compiled mypyc\nwheels, which make Black significantly faster. These issues have now been fixed, and\nthis release should come with compiled wheels once again.
\nThere will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12\nwheels in a future release as soon as the mypyc bug is fixed.
\nPackaging
\n\n
\n- Upgrade to mypy 1.5.1 (#3864)
\nPerformance
\n\n
\n- Store raw tuples instead of NamedTuples in Black's cache, improving performance and\ndecreasing the size of the cache (#3877)
\n23.9.0
\nPreview style
\n\n
\n- More concise formatting for dummy implementations (#3796)
\n- In stub files, add a blank line between a statement with a body (e.g an\n
\nif 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)
\nConfiguration
\n\n
\n- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
\nPerformance
\n\n
\n- Avoid importing
\nIPython
if notebook cells do not contain magics (#3782)- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
\nBlackd
\n\n
\n- Fix an issue in
\nblackd
with single character input (#3558)Integrations
\n\n
\n- Black now has an\nofficial pre-commit mirror. Swapping\n
\nhttps://github.com/psf/black
tohttps://github.com/psf/black-pre-commit-mirror
in\nyour.pre-commit-config.yaml
will make Black about 2x faster (#3828)- The
\n.black.env
folder specified byENV_PATH
will now be removed on the completion\nof 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.
\n\n\nChangelog
\n\n2023.09.10 -- Zesty Zaffre
\n\n
\n- Make asset hash injection idempotent, fixing Sphinx 6 compatibility.
\n- Fix the check for HTML builders, fixing non-HTML Read the Docs builds.
\n2023.08.19 -- Xenolithic Xanadu
\n\n
\n- Fix missing search context with Sphinx 7.2, for dirhtml builds.
\n- Drop support for Python 3.7.
\n- Present configuration errors in a better format -- thanks
\n@\u200bAA-Turner
!- Bump
\nrequire_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
\n\n
\n- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
... (truncated)
\n2718ca4
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.
\n\n\n23.9.1
\nDue to various issues, the previous release (23.9.0) did not include compiled mypyc\nwheels, which make Black significantly faster. These issues have now been fixed, and\nthis release should come with compiled wheels once again.
\nThere will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12\nwheels in a future release as soon as the mypyc bug is fixed.
\nPackaging
\n\n
\n- Upgrade to mypy 1.5.1 (#3864)
\nPerformance
\n\n
\n- Store raw tuples instead of NamedTuples in Black's cache, improving performance and\ndecreasing the size of the cache (#3877)
\n23.9.0
\nPreview style
\n\n
\n- More concise formatting for dummy implementations (#3796)
\n- In stub files, add a blank line between a statement with a body (e.g an\n
\nif 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)
\nConfiguration
\n\n
\n- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
\nPerformance
\n\n
\n- Avoid importing
\nIPython
if notebook cells do not contain magics (#3782)- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
\nBlackd
\n\n
\n- Fix an issue in
\nblackd
with single character input (#3558)Integrations
\n\n
\n- Black now has an\nofficial pre-commit mirror. Swapping\n
\nhttps://github.com/psf/black
tohttps://github.com/psf/black-pre-commit-mirror
in\nyour.pre-commit-config.yaml
will make Black about 2x faster (#3828)- The
\n.black.env
folder specified byENV_PATH
will now be removed on the completion\nof the GitHub Action (#3759)
Sourced from black's changelog.
\n\n\n23.9.1
\nDue to various issues, the previous release (23.9.0) did not include compiled mypyc\nwheels, which make Black significantly faster. These issues have now been fixed, and\nthis release should come with compiled wheels once again.
\nThere will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12\nwheels in a future release as soon as the mypyc bug is fixed.
\nPackaging
\n\n
\n- Upgrade to mypy 1.5.1 (#3864)
\nPerformance
\n\n
\n- Store raw tuples instead of NamedTuples in Black's cache, improving performance and\ndecreasing the size of the cache (#3877)
\n23.9.0
\nPreview style
\n\n
\n- More concise formatting for dummy implementations (#3796)
\n- In stub files, add a blank line between a statement with a body (e.g an\n
\nif 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)
\nConfiguration
\n\n
\n- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
\nPerformance
\n\n
\n- Avoid importing
\nIPython
if notebook cells do not contain magics (#3782)- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
\nBlackd
\n\n
\n- Fix an issue in
\nblackd
with single character input (#3558)Integrations
\n\n
\n- Black now has an\nofficial pre-commit mirror. Swapping\n
\nhttps://github.com/psf/black
tohttps://github.com/psf/black-pre-commit-mirror
in\nyour.pre-commit-config.yaml
will make Black about 2x faster (#3828)- The
\n.black.env
folder specified byENV_PATH
will now be removed on the completion\nof 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.
\n\n\nSphinx 7.2.5
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.5 (released Aug 30, 2023)
\nBugs fixed
\n\n
\n- #11645: Fix a regression preventing autodoc from importing modules within\npackages that make use of
\nif typing.TYPE_CHECKING:
to guard circular\nimports needed by type checkers.\nPatch by Matt Wozniski.- #11634: Fixed inheritance diagram relative link resolution\nfor sibling files in a subdirectory.\nPatch by Albert Shih.
\n- #11659: Allow
\n?config=...
in :confval:mathjax_path
.- #11654: autodoc: Fail with a more descriptive error message\nwhen an object claims to be an instance of
\ntype
,\nbut is not a class.\nPatch by James Braza.- 11620: Cease emitting :event:
\nsource-read
events for files read via\nthe :dudir:include
directive.- 11620: Add a new :event:
\ninclude-read
for observing and transforming\nthe content of included files via the :dudir:include
directive.- #11627: Restore support for copyright lines of the form
\nYYYY
\nwhenSOURCE_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.
\n\n\nSphinx 7.2.4
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.3
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.4 (released Aug 28, 2023)
\nBugs fixed
\n\n
\n- #11618: Fix a regression in the MoveModuleTargets transform,\nintroduced in #10478 (#9662).
\n- #11649: linkcheck: Resolve hanging tests for timezones west of London\nand incorrect conversion from UTC to offsets from the UNIX epoch.\nPatch by Dmitry Shachnev and Adam Turner.
\nRelease 7.2.3 (released Aug 23, 2023)
\nDependencies
\n\n
\n- #11576: Require sphinxcontrib-serializinghtml 1.1.9.
\nBugs fixed
\n\n
\n- Fix regression in
\nautodoc.Documenter.parse_name()
.- Fix regression in JSON serialisation.
\n- #11543: autodoc: Support positional-only parameters in
\nclassmethod
methods\nwhenautodoc_preserve_defaults
isTrue
.- Restore support string methods on path objects.\nThis is deprecated and will be removed in Sphinx 8.\nUse :py:func:
\nos.fspath
to convert :py:class:~pathlib.Path
objects to strings,\nor :py:class:~pathlib.Path
's methods to work with path objects.Release 7.2.2 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Fix the signature of the
\nStateMachine.insert_input()
patch,\nfor when calling with keyword arguments.- Fixed membership testing (
\nin
) for the :py:class:str
interface\nof the asset classes (_CascadingStyleSheet
and_JavaScript
),\nwhich several extensions relied upon.- Fixed a type error in
\nSingleFileHTMLBuilder._get_local_toctree
,\nincludehidden
may be passed as a string or a boolean.- Fix
\n:noindex:
forPyModule
andJSModule
.Release 7.2.1 (released Aug 17, 2023)
\n\n
... (truncated)
\n3256f1f
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.
\n\n\nChangelog
\n\n2023.08.19 -- Xenolithic Xanadu
\n\n
\n- Fix missing search context with Sphinx 7.2, for dirhtml builds.
\n- Drop support for Python 3.7.
\n- Present configuration errors in a better format -- thanks
\n@\u200bAA-Turner
!- Bump
\nrequire_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
\n\n
\n- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n
... (truncated)
\n0766bb2
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.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#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.
\n\n\nSphinx 7.2.3
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.3 (released Aug 23, 2023)
\nDependencies
\n\n
\n- #11576: Require sphinxcontrib-serializinghtml 1.1.9.
\nBugs fixed
\n\n
\n- Fix regression in
\nautodoc.Documenter.parse_name()
.- Fix regression in JSON serialisation.
\n- #11543: autodoc: Support positional-only parameters in
\nclassmethod
methods\nwhenautodoc_preserve_defaults
isTrue
.- Restore support string methods on path objects.\nThis is deprecated and will be removed in Sphinx 8.\nUse :py:func
\nos.fspath
to convert :py:class:pathlib.Path
objects to strings,\nor :py:class:pathlib.Path
's methods to work with path objects.Release 7.2.2 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Fix the signature of the
\nStateMachine.insert_input()
patch,\nfor when calling with keyword arguments.- Fixed membership testing (
\nin
) for the :py:class:str
interface\nof the asset classes (_CascadingStyleSheet
and_JavaScript
),\nwhich several extensions relied upon.- Fixed a type error in
\nSingleFileHTMLBuilder._get_local_toctree
,\nincludehidden
may be passed as a string or a boolean.- Fix
\n:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Restored the the :py:class:
\nstr
interface of the asset classes\n(_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.\nThis will be removed in Sphinx 9.- Restored calls to
\nBuilder.add_{css,js}_file()
,\nwhich several extensions relied upon.- Restored the private API
\nTocTree.get_toctree_ancestors()
,\nwhich several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
\n\n
... (truncated)
\n2f6ea14
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.
\n\n\nChangelog
\n\n2023.08.19 -- Xenolithic Xanadu
\n\n
\n- Fix missing search context with Sphinx 7.2, for dirhtml builds.
\n- Drop support for Python 3.7.
\n- Present configuration errors in a better format -- thanks
\n@\u200bAA-Turner
!- Bump
\nrequire_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
\n\n
\n- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n
... (truncated)
\n0766bb2
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.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#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.
\n\n\nSphinx 7.2.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.2 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Fix the signature of the
\nStateMachine.insert_input()
patch,\nfor when calling with keyword arguments.- Fixed membership testing (
\nin
) for the :py:class:str
interface\nof the asset classes (_CascadingStyleSheet
and_JavaScript
),\nwhich several extensions relied upon.- Fixed a type error in
\nSingleFileHTMLBuilder._get_local_toctree
,\nincludehidden
may be passed as a string or a boolean.- Fix
\n:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Restored the the :py:class:
\nstr
interface of the asset classes\n(_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.\nThis will be removed in Sphinx 9.- Restored calls to
\nBuilder.add_{css,js}_file()
,\nwhich several extensions relied upon.- Restored the private API
\nTocTree.get_toctree_ancestors()
,\nwhich several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
\nDependencies
\n\nDeprecated
\n\n
\n\n- #11512: Deprecate
\nsphinx.util.md5
andsphinx.util.sha1
.\nUsehashlib
instead.- #11526: Deprecate
\nsphinx.testing.path
.\nUseos.path
orpathlib
instead.- #11528: Deprecate
\nsphinx.util.split_index_msg
andsphinx.util.split_into
.\nUsesphinx.util.index_entries.split_index_msg
instead.- Deprecate
\nsphinx.builders.html.Stylesheet
\nandsphinx.builders.html.Javascript
.\nUsesphinx.application.Sphinx.add_css_file()
... (truncated)
\ned84d63
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.
\n\n\nChangelog
\n\n2023.08.19 -- Xenolithic Xanadu
\n\n
\n- Fix missing search context with Sphinx 7.2, for dirhtml builds.
\n- Drop support for Python 3.7.
\n- Present configuration errors in a better format -- thanks
\n@\u200bAA-Turner
!- Bump
\nrequire_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
\n\n
\n- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n
... (truncated)
\n0766bb2
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.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#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.
\n\n\nSphinx 7.2.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.2 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Fix the signature of the
\nStateMachine.insert_input()
patch,\nfor when calling with keyword arguments.- Fixed membership testing (
\nin
) for the :py:class:str
interface\nof the asset classes (_CascadingStyleSheet
and_JavaScript
),\nwhich several extensions relied upon.- Fixed a type error in
\nSingleFileHTMLBuilder._get_local_toctree
,\nincludehidden
may be passed as a string or a boolean.- Fix
\n:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Restored the the :py:class:
\nstr
interface of the asset classes\n(_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.\nThis will be removed in Sphinx 9.- Restored calls to
\nBuilder.add_{css,js}_file()
,\nwhich several extensions relied upon.- Restored the private API
\nTocTree.get_toctree_ancestors()
,\nwhich several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
\nDependencies
\n\nDeprecated
\n\n
\n\n- #11512: Deprecate
\nsphinx.util.md5
andsphinx.util.sha1
.\nUsehashlib
instead.- #11526: Deprecate
\nsphinx.testing.path
.\nUseos.path
orpathlib
instead.- #11528: Deprecate
\nsphinx.util.split_index_msg
andsphinx.util.split_into
.\nUsesphinx.util.index_entries.split_index_msg
instead.- Deprecate
\nsphinx.builders.html.Stylesheet
\nandsphinx.builders.html.Javascript
.\nUsesphinx.application.Sphinx.add_css_file()
... (truncated)
\ned84d63
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.
\n\n\nChangelog
\n\n2023.08.17 -- Wonderous White
\n\n
\n- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n- Remove the "indent" of API entries which have a background.
\n- Break long inline code literals.
\n2022.12.07 -- Reverent Raspberry
\n\n
\n\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n
... (truncated)
\nSourced from blacken-docs's changelog.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#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.
\n\n\nSphinx 7.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.0 (released Aug 17, 2023)
\nDependencies
\n\nDeprecated
\n\n
\n- #11512: Deprecate
\nsphinx.util.md5
andsphinx.util.sha1
.\nUsehashlib
instead.- #11526: Deprecate
\nsphinx.testing.path
.\nUseos.path
orpathlib
instead.- #11528: Deprecate
\nsphinx.util.split_index_msg
andsphinx.util.split_into
.\nUsesphinx.util.index_entries.split_index_msg
instead.- Deprecate
\nsphinx.builders.html.Stylesheet
\nandsphinx.builders.html.Javascript
.\nUsesphinx.application.Sphinx.add_css_file()
\nandsphinx.application.Sphinx.add_js_file()
instead.- #11582: Deprecate
\nsphinx.builders.html.StandaloneHTMLBuilder.css_files
and\nsphinx.builders.html.StandaloneHTMLBuilder.script_files
.\nUsesphinx.application.Sphinx.add_css_file()
\nandsphinx.application.Sphinx.add_js_file()
instead.- #11459: Deprecate
\nsphinx.ext.autodoc.preserve_defaults.get_function_def()
.\nPatch by B\u00e9n\u00e9dikt Tran.Features added
\n\n
\n\n- #11526: Support
\nos.PathLike
types andpathlib.Path
objects\nin many more places.- #5474: coverage: Print summary statistics tables.\nPatch by Jorge Leitao.
\n- #6319: viewcode: Add :confval:
\nviewcode_line_numbers
to control\nwhether line numbers are added to rendered source code.\nPatch by Ben Krikler.- #9662: Add the
\n:no-typesetting:
option to suppress textual output\nand only create a linkable anchor.\nPatch by Latosha Maltba.- #11221: C++: Support domain objects in the table of contents.\nPatch by Rouslan Korneychuk.
\n- #10938: doctest: Add :confval:
\ndoctest_show_successes
option.\nPatch by Trey Hunner.- #11533: Add
\n:no-index:
,:no-index-entry:
, and:no-contents-entry:
.- #11572: Improve
\ndebug
logging of reasons why files are detected as out of\ndate.\nPatch by Eric Larson.
... (truncated)
\nda9f8a5
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.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#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.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#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.
\n\n\nSphinx 7.1.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.1.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.1.2 (released Aug 02, 2023)
\nBugs fixed
\n\n
\n- #11542: linkcheck: Properly respect :confval:
\nlinkcheck_anchors
\nand do not spuriously report failures to validate anchors.\nPatch by James Addison.Release 7.1.1 (released Jul 27, 2023)
\nBugs fixed
\n\n
\n- #11514: Fix
\nSOURCE_DATE_EPOCH
in multi-line copyright footer.\nPatch by B\u00e9n\u00e9dikt Tran.Release 7.1.0 (released Jul 24, 2023)
\nIncompatible changes
\n\n
\n- \n
\nReleases are no longer signed, given the
\nchange in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
\nDeprecated
\n\n
\n- #11412: Emit warnings on using a deprecated Python-specific index entry type\n(namely,
\nmodule
,keyword
,operator
,object
,exception
,\nstatement
, andbuiltin
) in the :rst:dir:index
directive, and\nset the removal version to Sphinx 9. Patch by Adam Turner.Features added
\n\n
\n\n- #11415: Add a checksum to JavaScript and CSS asset URIs included within\ngenerated HTML, using the CRC32 algorithm.
\n- :meth:
\n~sphinx.application.Sphinx.require_sphinx
now allows the version\nrequirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via\n:confval:
\nmaximum_signature_line_length
and the domain-specific variants.\nIf the length of the signature (in characters) is greater than the configured\nlimit, each parameter in the signature will be split to its own logical line.\nThis behaviour may also be controlled by options on object description\ndirectives, for example :rst:dir:py:function:single-line-parameter-list
.
... (truncated)
\n320d0b6
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.
\n\n\nChangelog
\n\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n- Remove the "indent" of API entries which have a background.
\n- Break long inline code literals.
\n2022.12.07 -- Reverent Raspberry
\n\n
\n\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n- Drop support for Sphinx 4.
\n- Improve documentation about what the edit button does.
\n- Improve handling of empty-flexboxes for better print experience on Chrome.
\n- Improve styling for inline signatures.
\n
... (truncated)
\n35f5307
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)Sourced from blacken-docs's changelog.
\n\n\n1.15.0 (2023-07-09)
\n\n
\n- Drop Python 3.7 support.
\n
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.
\n\n\nSphinx 7.1.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.1.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.1.2 (released Aug 02, 2023)
\nBugs fixed
\n\n
\n- #11542: linkcheck: Properly respect :confval:
\nlinkcheck_anchors
\nand do not spuriously report failures to validate anchors.\nPatch by James Addison.Release 7.1.1 (released Jul 27, 2023)
\nBugs fixed
\n\n
\n- #11514: Fix
\nSOURCE_DATE_EPOCH
in multi-line copyright footer.\nPatch by B\u00e9n\u00e9dikt Tran.Release 7.1.0 (released Jul 24, 2023)
\nIncompatible changes
\n\n
\n- \n
\nReleases are no longer signed, given the
\nchange in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
\nDeprecated
\n\n
\n- #11412: Emit warnings on using a deprecated Python-specific index entry type\n(namely,
\nmodule
,keyword
,operator
,object
,exception
,\nstatement
, andbuiltin
) in the :rst:dir:index
directive, and\nset the removal version to Sphinx 9. Patch by Adam Turner.Features added
\n\n
\n\n- #11415: Add a checksum to JavaScript and CSS asset URIs included within\ngenerated HTML, using the CRC32 algorithm.
\n- :meth:
\n~sphinx.application.Sphinx.require_sphinx
now allows the version\nrequirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via\n:confval:
\nmaximum_signature_line_length
and the domain-specific variants.\nIf the length of the signature (in characters) is greater than the configured\nlimit, each parameter in the signature will be split to its own logical line.\nThis behaviour may also be controlled by options on object description\ndirectives, for example :rst:dir:py:function:single-line-parameter-list
.
... (truncated)
\n320d0b6
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 sphinx's releases.
\n\n\nSphinx 7.1.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.1.1 (released Jul 27, 2023)
\nBugs fixed
\n\n
\n- #11514: Fix
\nSOURCE_DATE_EPOCH
in multi-line copyright footer.\nPatch by B\u00e9n\u00e9dikt Tran.Release 7.1.0 (released Jul 24, 2023)
\nIncompatible changes
\n\n
\n- \n
\nReleases are no longer signed, given the
\nchange in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
\nDeprecated
\n\n
\n- #11412: Emit warnings on using a deprecated Python-specific index entry type\n(namely,
\nmodule
,keyword
,operator
,object
,exception
,\nstatement
, andbuiltin
) in the :rst:dir:index
directive, and\nset the removal version to Sphinx 9. Patch by Adam Turner.Features added
\n\n
\n\n- #11415: Add a checksum to JavaScript and CSS asset URIs included within\ngenerated HTML, using the CRC32 algorithm.
\n- :meth:
\n~sphinx.application.Sphinx.require_sphinx
now allows the version\nrequirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via\n:confval:
\nmaximum_signature_line_length
and the domain-specific variants.\nIf the length of the signature (in characters) is greater than the configured\nlimit, each parameter in the signature will be split to its own logical line.\nThis behaviour may also be controlled by options on object description\ndirectives, for example :rst:dir:py:function:single-line-parameter-list
.\nPatch by Thomas Louf, Adam Turner, and Jean-Fran\u00e7ois B.- #10983: Support for multiline copyright statements in the footer block.\nPatch by Stefanie Molin
\n- \n
sphinx.util.display.status_iterator
now clears the current line\nwith ANSI control codes, rather than overprinting with space characters.- #11431: linkcheck: Treat SSL failures as broken links.\nPatch by B\u00e9n\u00e9dikt Tran
\n- #11157: Keep the
\ntranslated
attribute on translated nodes.- #11451: Improve the traceback displayed when using :option:
\nsphinx-build -T
\nin parallel builds. Patch by B\u00e9n\u00e9dikt Tran
... (truncated)
\nd8d73c1
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 furo's changelog.
\n\n\nChangelog
\n\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n- Remove the "indent" of API entries which have a background.
\n- Break long inline code literals.
\n2022.12.07 -- Reverent Raspberry
\n\n
\n\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n- Drop support for Sphinx 4.
\n- Improve documentation about what the edit button does.
\n- Improve handling of empty-flexboxes for better print experience on Chrome.
\n- Improve styling for inline signatures.
\n
... (truncated)
\n35f5307
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)Sourced from sphinx's releases.
\n\n\nSphinx 7.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.1.0 (released Jul 24, 2023)
\nIncompatible changes
\n\n
\n- \n
\nReleases are no longer signed, given the
\nchange in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
\nDeprecated
\n\n
\n- #11412: Emit warnings on using a deprecated Python-specific index entry type\n(namely,
\nmodule
,keyword
,operator
,object
,exception
,\nstatement
, andbuiltin
) in the :rst:dir:index
directive, and\nset the removal version to Sphinx 9. Patch by Adam Turner.Features added
\n\n
\n\n- #11415: Add a checksum to JavaScript and CSS asset URIs included within\ngenerated HTML, using the CRC32 algorithm.
\n- :meth:
\n~sphinx.application.Sphinx.require_sphinx
now allows the version\nrequirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via\n:confval:
\nmaximum_signature_line_length
and the domain-specific variants.\nIf the length of the signature (in characters) is greater than the configured\nlimit, each parameter in the signature will be split to its own logical line.\nThis behaviour may also be controlled by options on object description\ndirectives, for example :rst:dir:py:function:single-line-parameter-list
.\nPatch by Thomas Louf, Adam Turner, and Jean-Fran\u00e7ois B.- #10983: Support for multiline copyright statements in the footer block.\nPatch by Stefanie Molin
\n- \n
sphinx.util.display.status_iterator
now clears the current line\nwith ANSI control codes, rather than overprinting with space characters.- #11431: linkcheck: Treat SSL failures as broken links.\nPatch by B\u00e9n\u00e9dikt Tran
\n- #11157: Keep the
\ntranslated
attribute on translated nodes.- #11451: Improve the traceback displayed when using :option:
\nsphinx-build -T
\nin parallel builds. Patch by B\u00e9n\u00e9dikt Tran- #11324: linkcheck: Use session-basd HTTP requests.
\n- #11438: Add support for the :rst:dir:
\npy:class
and :rst:dir:py:function
\ndirectives for PEP 695 (generic classes and functions declarations) and\nPEP 696 (default type parameters). Multi-line support (#11011) is enabled\nfor type parameters list and can be locally controlled on object description\ndirectives, e.g., :rst:dir:py:function:single-line-type-parameter-list
.\nPatch by B\u00e9n\u00e9dikt Tran.- #11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis\nvia :confval:
\nlinkcheck_anchors_ignore_for_url
while
... (truncated)
\ne560f63
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 black's releases.
\n\n\n23.7.0
\nHighlights
\n\n
\n- Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be\nsupported until further notice (#3765)
\nStable style
\n\n
\n- Fix a bug where an illegal trailing comma was added to return type annotations using\nPEP 604 unions (#3735)
\n- Fix several bugs and crashes where comments in stub files were removed or mishandled\nunder some circumstances (#3745)
\n- Fix a crash with multi-line magic comments like
\ntype: ignore
within parentheses\n(#3740)- Fix error in AST validation when Black removes trailing whitespace in a type comment\n(#3773)
\nPreview style
\n\n
\n- Implicitly concatenated strings used as function args are no longer wrapped inside\nparentheses (#3640)
\n- Remove blank lines between a class definition and its docstring (#3692)
\nConfiguration
\n\n
\n- The
\n--workers
argument to Black can now be specified via theBLACK_NUM_WORKERS
\nenvironment variable (#3743)- \n
.pytest_cache
,.ruff_cache
and.vscode
are now excluded by default (#3691)- Fix Black not honouring
\npyproject.toml
settings when running--stdin-filename
\nand thepyproject.toml
found isn't in the current working directory (#3719)- Black will now error if
\nexclude
andextend-exclude
have invalid data types in\npyproject.toml
, instead of silently doing the wrong thing (#3764)Packaging
\n\n
\n- Upgrade mypyc from 0.991 to 1.3 (#3697)
\n- Remove patching of Click that mitigated errors on Python 3.6 with
\nLANG=C
(#3768)Parser
\n\n
\n- Add support for the new PEP 695 syntax in Python 3.12 (#3703)
\nPerformance
\n\n
\n- Speed up Black significantly when the cache is full (#3751)
\n- Avoid importing
\nIPython
in a case where we wouldn't need it (#3748)Output
\n\n
... (truncated)
\nSourced from black's changelog.
\n\n\n23.7.0
\nHighlights
\n\n
\n- Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be\nsupported until further notice (#3765)
\nStable style
\n\n
\n- Fix a bug where an illegal trailing comma was added to return type annotations using\nPEP 604 unions (#3735)
\n- Fix several bugs and crashes where comments in stub files were removed or mishandled\nunder some circumstances (#3745)
\n- Fix a crash with multi-line magic comments like
\ntype: ignore
within parentheses\n(#3740)- Fix error in AST validation when Black removes trailing whitespace in a type comment\n(#3773)
\nPreview style
\n\n
\n- Implicitly concatenated strings used as function args are no longer wrapped inside\nparentheses (#3640)
\n- Remove blank lines between a class definition and its docstring (#3692)
\nConfiguration
\n\n
\n- The
\n--workers
argument to Black can now be specified via theBLACK_NUM_WORKERS
\nenvironment variable (#3743)- \n
.pytest_cache
,.ruff_cache
and.vscode
are now excluded by default (#3691)- Fix Black not honouring
\npyproject.toml
settings when running--stdin-filename
\nand thepyproject.toml
found isn't in the current working directory (#3719)- Black will now error if
\nexclude
andextend-exclude
have invalid data types in\npyproject.toml
, instead of silently doing the wrong thing (#3764)Packaging
\n\n
\n- Upgrade mypyc from 0.991 to 1.3 (#3697)
\n- Remove patching of Click that mitigated errors on Python 3.6 with
\nLANG=C
(#3768)Parser
\n\n
\n- Add support for the new PEP 695 syntax in Python 3.12 (#3703)
\nPerformance
\n\n
\n- Speed up Black significantly when the cache is full (#3751)
\n- Avoid importing
\nIPython
in a case where we wouldn't need it (#3748)Output
\n\n
... (truncated)
\n193ee76
Prepare release 23.7.0 (#3776)38723bb
Unpin pytest-xdist (#3772)138769a
Disable coverage on pypy tests (#3777)ad3724b
Upgrade to latest mypy (#3775)b8e2ec7
Fix crash on type comment with trailing space (#3773)257d392
Fix removed comments in stub files (#3745)2593af2
Improve performance by skipping unnecessary normalisation (#3751)f3b50e4
Add CITATION.cff file (#3723)0b4d7d5
Run pyupgrade on blib2to3 and src (#3771)114e835
Remove click patch (#3768)Sourced from blacken-docs's changelog.
\n\n\n1.15.0 (2023-07-09)
\n\n
\n- Drop Python 3.7 support.
\n
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 blacken-docs's changelog.
\n\n\n1.14.0 (2023-06-13)
\n\n
\n- Support Python 3.12.
\n
4b94add
Version 1.14.0292cb18
Support Python 3.12 (#251)72ecf2c
[pre-commit.ci] pre-commit autoupdate (#249)ea8f1ca
Upgrade requirements (#248)9979d7a
Upgrade requirements (#247)7b71075
[pre-commit.ci] pre-commit autoupdate (#245)6280868
[pre-commit.ci] pre-commit autoupdate (#244)83efc37
Upgrade requirements (#243)7aedc23
[pre-commit.ci] pre-commit autoupdate (#242)d78d593
[pre-commit.ci] pre-commit autoupdate (#241)Sourced from furo's changelog.
\n\n\nChangelog
\n\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n- Remove the "indent" of API entries which have a background.
\n- Break long inline code literals.
\n2022.12.07 -- Reverent Raspberry
\n\n
\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n- Drop support for Sphinx 4.
\n- Improve documentation about what the edit button does.
\n- Improve handling of empty-flexboxes for better print experience on Chrome.
\n- Improve styling for inline signatures.
\n- Replace the
\nmeta
generator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
\n2022.09.29 -- Quaint Quartz
\n\n
\n\n- Add ability to set arbitrary URLs for edit button.
\n
... (truncated)
\nd2c9ca8
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)Sourced from sphinx's releases.
\n\n\nv7.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.0.1 (released May 12, 2023)
\nDependencies
\n\n
\n- #11411: Support
\nDocutils 0.20
_. Patch by Adam Turner... _Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04
\nBugs fixed
\n\n
\n- #11418: Clean up remaining references to
\nsphinx.setup_command
\nfollowing the removal of support for setuptools.\nPatch by Willem Mulder.Release 7.0.0 (released Apr 29, 2023)
\nIncompatible changes
\n\n
\n- #11359: Remove long-deprecated aliases for
\nMecabSplitter
and\nDefaultSplitter
insphinx.search.ja
.- #11360: Remove deprecated
\nmake_old_id
functions in domain object\ndescription classes.- #11363: Remove the Setuptools integration (
\nbuild_sphinx
hook in\nsetup.py
).- #11364: Remove deprecated
\nsphinx.ext.napoleon.iterators
module.- #11365: Remove support for the
\njsdump
format insphinx.search
.- #11366: Make
\nlocale
a required argument to\nsphinx.util.i18n.format_date()
.- #11370: Remove deprecated
\nsphinx.util.stemmer
module.- #11371: Remove deprecated
\nsphinx.pycode.ast.parse()
function.- #11372: Remove deprecated
\nsphinx.io.read_doc()
function.- #11373: Removed deprecated
\nsphinx.util.get_matching_files()
function.- #11378: Remove deprecated
\nsphinx.util.docutils.is_html5_writer_available()
\nfunction.- #11379: Make the
\nenv
argument toBuilder
subclasses required.- #11380: autosummary: Always emit grouped import exceptions.
\n- #11381: Remove deprecated
\nstyle
key for HTML templates.- #11382: Remove deprecated
\nsphinx.writers.latex.LaTeXTranslator.docclasses
\nattribute.- #11383: Remove deprecated
\nsphinx.builders.html.html5_ready
and\nsphinx.builders.html.HTMLTranslator
attributes.- #11385: Remove support for HTML 4 output.
\nRelease 6.2.1 (released Apr 25, 2023)
\n\n
... (truncated)
\nd48cc78
Bump to 7.0.1 finalde6b18a
Remove remaining references to the setuptools integration (#11418)db54618
Support Docutils 0.20 (#11411)8942a1d
Test with Docutils 0.20c9d0933
linkcheck: Use context managers for HTTP requests (#11318)2b1c106
Update documentation workflowba74082
Change concurrency groups for GitHub workflowsb546879
Bump versiond568b2f
Bump to 7.0.0 finalff79edf
Remove jsdump
references post removalSourced from sphinx's releases.
\n\n\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.0.0 (released Apr 29, 2023)
\nIncompatible changes
\n\n
\n- #11359: Remove long-deprecated aliases for
\nMecabSplitter
and\nDefaultSplitter
insphinx.search.ja
.- #11360: Remove deprecated
\nmake_old_id
functions in domain object\ndescription classes.- #11363: Remove the Setuptools integration (
\nbuild_sphinx
hook in\nsetup.py
).- #11364: Remove deprecated
\nsphinx.ext.napoleon.iterators
module.- #11365: Remove support for the
\njsdump
format insphinx.search
.- #11366: Make
\nlocale
a required argument to\nsphinx.util.i18n.format_date()
.- #11370: Remove deprecated
\nsphinx.util.stemmer
module.- #11371: Remove deprecated
\nsphinx.pycode.ast.parse()
function.- #11372: Remove deprecated
\nsphinx.io.read_doc()
function.- #11373: Removed deprecated
\nsphinx.util.get_matching_files()
function.- #11378: Remove deprecated
\nsphinx.util.docutils.is_html5_writer_available()
\nfunction.- #11379: Make the
\nenv
argument toBuilder
subclasses required.- #11380: autosummary: Always emit grouped import exceptions.
\n- #11381: Remove deprecated
\nstyle
key for HTML templates.- #11382: Remove deprecated
\nsphinx.writers.latex.LaTeXTranslator.docclasses
\nattribute.- #11383: Remove deprecated
\nsphinx.builders.html.html5_ready
and\nsphinx.builders.html.HTMLTranslator
attributes.- #11385: Remove support for HTML 4 output.
\nRelease 6.2.1 (released Apr 25, 2023)
\nBugs fixed
\n\n
\n- #11355: Revert the default type of :confval:
\nnitpick_ignore
and\n:confval:nitpick_ignore_regex
tolist
.Release 6.2.0 (released Apr 23, 2023)
\nDependencies
\n\n
\n- Require Docutils 0.18.1 or greater.
\nIncompatible changes
\n\n
... (truncated)
\nd568b2f
Bump to 7.0.0 finalff79edf
Remove jsdump
references post removal1a5133a
Bump to 7.0.0rc1 final5795fc7
Update sphinx.deprecation
for Sphinx 7.0 (#11386)6202087
Add a note to CHANGES for PR 11385ad47373
Remove HTML 4 support (#11385)3e3251d
Remove HTMLTranslator
and html5_ready
from sphinx.builders.html
(...77fd819
Remove deprecated LaTeXTranslator.docclasses
attribute (#11382)4be56f3
Remove deprecated style
key for HTML templates (#11381)49027a9
Autosummary: Always emit grouped ImportError
exceptions (#11380)Sourced from sphinx's releases.
\n\n\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 6.2.1 (released Apr 25, 2023)
\nBugs fixed
\n\n
\n- #11355: Revert the default type of :confval:
\nnitpick_ignore
and\n:confval:nitpick_ignore_regex
tolist
.Release 6.2.0 (released Apr 23, 2023)
\nDependencies
\n\n
\n- Require Docutils 0.18.1 or greater.
\nIncompatible changes
\n\n
\n- LaTeX: removal of some internal TeX
\n\\dimen
registers (not previously\npublicly documented) as per 5.1.0 code comments insphinx.sty
:\n\\sphinxverbatimsep
,\\sphinxverbatimborder
,\\sphinxshadowsep
,\n\\sphinxshadowsize
, and\\sphinxshadowrule
. (refs: #11105)- Remove
\n.egg
support from pycodeModuleAnalyser
; Python eggs are a\nnow-obsolete binary distribution format- #11089: Remove deprecated code in
\nsphinx.builders.linkcheck
.\nPatch by Daniel Eades- Remove internal-only
\nsphinx.locale.setlocale
Deprecated
\n\n
\n- #11247: Deprecate the legacy
\nintersphinx_mapping
format- \n
sphinx.util.osutil.cd
is deprecated in favour ofcontextlib.chdir
.Features added
\n\n
\n\n- #11277: :rst:dir:
\nautoproperty
allows the return type to be specified as\na type comment (e.g.,# type: () -> int
). Patch by B\u00e9n\u00e9dikt Tran- #10811: Autosummary: extend
\n__all__
to imported members for template rendering\nwhen optionautosummary_ignore_module_all
is set toFalse
. Patch by\nClement Pinard- #11147: Add a
\ncontent_offset
parameter tonested_parse_with_titles()
,\nallowing for correct line numbers during nested parsing.\nPatch by Jeremy Maitin-Shepard- Update to Unicode CLDR 42
\n- Add a
\n--jobs
synonym for-j
. Patch by Hugo van Kemenade- LaTeX: a command
\n\\sphinxbox
for styling text elements with a (possibly
... (truncated)
\nec993dd
Bump to 6.2.1 finald2aa91f
Revert the default type of nitpick_ignore[_regex]
to list
60d8fa1
Bump version70102ac
Bump to 6.2.0 final4e27a5f
Remove unneeded JavaScript from sphinx13
themebffb547
Note correct deprecation version for sphinx.util.osutil.cd
59de8d5
Revert "Support and prefer .jinja
to _t
for static templates (#11165)...aee3c0a
Partially revert "Disable localisation when SOURCE_DATE_EPOCH is set (#10949)...186d596
Use overwrite_file
context manager in test_ext_autodoc_configs
(#11320)77483f2
Add missing test decorator for test_util_inspect
(#11321)Sourced from sphinx's releases.
\n\n\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 6.2.0 (released Apr 23, 2023)
\nDependencies
\n\n
\n- Require Docutils 0.18.1 or greater.
\nIncompatible changes
\n\n
\n- LaTeX: removal of some internal TeX
\n\\dimen
registers (not previously\npublicly documented) as per 5.1.0 code comments insphinx.sty
:\n\\sphinxverbatimsep
,\\sphinxverbatimborder
,\\sphinxshadowsep
,\n\\sphinxshadowsize
, and\\sphinxshadowrule
. (refs: #11105)- Remove
\n.egg
support from pycodeModuleAnalyser
; Python eggs are a\nnow-obsolete binary distribution format- #11089: Remove deprecated code in
\nsphinx.builders.linkcheck
.\nPatch by Daniel Eades- Remove internal-only
\nsphinx.locale.setlocale
Deprecated
\n\n
\n- #11247: Deprecate the legacy
\nintersphinx_mapping
format- \n
sphinx.util.osutil.cd
is deprecated in favour ofcontextlib.chdir
.Features added
\n\n
\n\n- #11277: :rst:dir:
\nautoproperty
allows the return type to be specified as\na type comment (e.g.,# type: () -> int
). Patch by B\u00e9n\u00e9dikt Tran- #10811: Autosummary: extend
\n__all__
to imported members for template rendering\nwhen optionautosummary_ignore_module_all
is set toFalse
. Patch by\nClement Pinard- #11147: Add a
\ncontent_offset
parameter tonested_parse_with_titles()
,\nallowing for correct line numbers during nested parsing.\nPatch by Jeremy Maitin-Shepard- Update to Unicode CLDR 42
\n- Add a
\n--jobs
synonym for-j
. Patch by Hugo van Kemenade- LaTeX: a command
\n\\sphinxbox
for styling text elements with a (possibly\nrounded) box, optional background color and shadow, has been added.\nSee :ref:sphinxbox
. (refs: #11224)- LaTeX: add
\n\\sphinxstylenotetitle
, ...,\\sphinxstylewarningtitle
, ...,\nfor an extra layer of mark-up freeing up\\sphinxstrong
for other uses.\nSee :ref:latex-macros
. (refs: #11267)- LaTeX: :dudir:
\nnote
, :dudir:hint
, :dudir:important
and :dudir:tip
can\nnow each be styled as the other admonitions, i.e. possibly with a background\ncolor, individual border widths and paddings, possibly rounded corners, and\noptional shadow. See :ref:additionalcss
. (refs: #11234)
... (truncated)
\ne7d4c36
Bump to 6.2.0 final4e27a5f
Remove unneeded JavaScript from sphinx13
themebffb547
Note correct deprecation version for sphinx.util.osutil.cd
59de8d5
Revert "Support and prefer .jinja
to _t
for static templates (#11165)...aee3c0a
Partially revert "Disable localisation when SOURCE_DATE_EPOCH is set (#10949)...186d596
Use overwrite_file
context manager in test_ext_autodoc_configs
(#11320)77483f2
Add missing test decorator for test_util_inspect
(#11321)d8f15c7
Increase timeout threshold for linkcheck
tests (#11326)b430e05
Create a 'search field' component for themes (#11045)e2f66ce
Update CHANGES for PR #11333Sourced from black's releases.
\n\n\n23.3.0
\nHighlights
\nThis release fixes a longstanding confusing behavior in Black's GitHub action, where the\nversion of the action did not determine the version of Black being run (issue #3382). In\naddition, there is a small bug fix around imports and a number of improvements to the\npreview style.
\nPlease try out the\npreview style\nwith
\nblack --preview
and tell us your feedback. All changes in the preview style are\nexpected to become part of Black's stable style in January 2024.Stable style
\n\n
\n- Import lines with
\n# fmt: skip
and# fmt: off
no longer have an extra blank line\nadded when they are right after another import line (#3610)Preview style
\n\n
\n- Add trailing commas to collection literals even if there's a comment after the last\nentry (#3393)
\n- \n
async def
,async for
, andasync with
statements are now formatted consistently\ncompared to their non-async version. (#3609)- \n
with
statements that contain two context managers will be consistently wrapped in\nparentheses (#3589)- Let string splitters respect East Asian Width\n(#3445)
\n- Now long string literals can be split after East Asian commas and periods (
\n\u3001
U+3001\nIDEOGRAPHIC COMMA,\u3002
U+3002 IDEOGRAPHIC FULL STOP, &\uff0c
U+FF0C FULLWIDTH COMMA)\nbesides before spaces (#3445)- For stubs, enforce one blank line after a nested class with a body other than just\n
\n...
(#3564)- Improve handling of multiline strings by changing line split behavior (#1879)
\nParser
\n\n
\n- Added support for formatting files with invalid type comments (#3594)
\nIntegrations
\n\n
\n- Update GitHub Action to use the version of Black equivalent to action's version if\nversion input is not specified (#3543)
\n- Fix missing Python binary path in autoload script for vim (#3508)
\nDocumentation
\n\n
\n\n- Document that only the most recent release is supported for security issues;\nvulnerabilities should be reported through Tidelift (#3612)
\n
... (truncated)
\nSourced from black's changelog.
\n\n\n23.3.0
\nHighlights
\nThis release fixes a longstanding confusing behavior in Black's GitHub action, where the\nversion of the action did not determine the version of Black being run (issue #3382). In\naddition, there is a small bug fix around imports and a number of improvements to the\npreview style.
\nPlease try out the\npreview style\nwith
\nblack --preview
and tell us your feedback. All changes in the preview style are\nexpected to become part of Black's stable style in January 2024.Stable style
\n\n
\n- Import lines with
\n# fmt: skip
and# fmt: off
no longer have an extra blank line\nadded when they are right after another import line (#3610)Preview style
\n\n
\n- Add trailing commas to collection literals even if there's a comment after the last\nentry (#3393)
\n- \n
async def
,async for
, andasync with
statements are now formatted consistently\ncompared to their non-async version. (#3609)- \n
with
statements that contain two context managers will be consistently wrapped in\nparentheses (#3589)- Let string splitters respect East Asian Width\n(#3445)
\n- Now long string literals can be split after East Asian commas and periods (
\n\u3001
U+3001\nIDEOGRAPHIC COMMA,\u3002
U+3002 IDEOGRAPHIC FULL STOP, &\uff0c
U+FF0C FULLWIDTH COMMA)\nbesides before spaces (#3445)- For stubs, enforce one blank line after a nested class with a body other than just\n
\n...
(#3564)- Improve handling of multiline strings by changing line split behavior (#1879)
\nParser
\n\n
\n- Added support for formatting files with invalid type comments (#3594)
\nIntegrations
\n\n
\n- Update GitHub Action to use the version of Black equivalent to action's version if\nversion input is not specified (#3543)
\n- Fix missing Python binary path in autoload script for vim (#3508)
\nDocumentation
\n\n
\n\n- Document that only the most recent release is supported for security issues;\nvulnerabilities should be reported through Tidelift (#3612)
\n
... (truncated)
\nbf7a162
Fixup the changelog (#3628)9b2b048
Prepare release 23.3.0 (#3625)bf5abdb
Specify Python exec path with minor version if available (#3508)b542f58
Use GH action version when version argument not specified (#3543)f3b1a3b
Bump furo from 2022.12.7 to 2023.3.23 in /docs (#3624)ef6e079
Let string splitters respect East_Asian_Width
property (#3445)5c064a9
Bump sphinx from 5.3.0 to 6.1.3 in /docs (#3499)3a9d6f0
Bump myst-parser from 0.18.1 to 1.0.0 in /docs (#3601)53c23e6
Support files with type comment syntax errors (#3594)dba3c26
Fix bug introduced in #3564. (#3615)Sourced from furo's changelog.
\n\n\nChangelog
\n\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n- Remove the "indent" of API entries which have a background.
\n- Break long inline code literals.
\n2022.12.07 -- Reverent Raspberry
\n\n
\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n- Drop support for Sphinx 4.
\n- Improve documentation about what the edit button does.
\n- Improve handling of empty-flexboxes for better print experience on Chrome.
\n- Improve styling for inline signatures.
\n- Replace the
\nmeta
generator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
\n2022.09.29 -- Quaint Quartz
\n\n
\n- Add ability to set arbitrary URLs for edit button.
\n- Add support for aligning text in MyST-parser generated tables.
\n2022.09.15 -- Pragmatic Pistachio
\n\n
\n\n- Add a minimum version constraint on pygments.
\n- Add an explicit dependency on
\nsass
.- Change right sidebar title from "Contents" to "On this page".
\n- Correctly position sidebars on small screens.
\n
... (truncated)
\n2f61e10
Prepare release: 2023.03.275c7aedd
Update changelog0535011
Add missing class to Font Awesome examples (#629)811f1e7
Remove unused templates_path
(#627)961d4e9
Add a inline-code as an example heading48af8eb
Back to development81139dd
Prepare release: 2023.03.23dafa73a
Update changelog82591ef
Allow all pre
tags to have overflows55b32f0
Update Python version classifiers (#626)Sourced from furo's changelog.
\n\n\nChangelog
\n\n2023.03.23 -- Sassy Saffron
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n- Remove the "indent" of API entries which have a background.
\n- Break long inline code literals.
\n2022.12.07 -- Reverent Raspberry
\n\n
\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n- Drop support for Sphinx 4.
\n- Improve documentation about what the edit button does.
\n- Improve handling of empty-flexboxes for better print experience on Chrome.
\n- Improve styling for inline signatures.
\n- Replace the
\nmeta
generator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
\n2022.09.29 -- Quaint Quartz
\n\n
\n- Add ability to set arbitrary URLs for edit button.
\n- Add support for aligning text in MyST-parser generated tables.
\n2022.09.15 -- Pragmatic Pistachio
\n\n
\n\n- Add a minimum version constraint on pygments.
\n- Add an explicit dependency on
\nsass
.- Change right sidebar title from "Contents" to "On this page".
\n- Correctly position sidebars on small screens.
\n- Correctly select only Furo's own
\nsvg
in related pagesnav
.- Make numpy-style documentation headers consistent.
\n- Retitle the reference section.
\n- Update npm dependencies.
\n
... (truncated)
\n81139dd
Prepare release: 2023.03.23dafa73a
Update changelog82591ef
Allow all pre
tags to have overflows55b32f0
Update Python version classifiers (#626)cd6ecdd
Update linters82a1cec
Drop the black pin in blacken-docs483b05c
Increase the icon size in mobile headerab3ca77
Revert "Increase icon sizes (#554)"82376d2
Supply encoding. Fixes #621. (#622)193643f
Increase admonition title bg opacity (#555)Sourced from black's releases.
\n\n\n23.1.0
\nHighlights
\nThis is the first release of 2023, and following our stability policy, it comes with a number of improvements to our stable style, notably improvements to empty line handling and the removal of redundant parentheses in several contexts.
\nThere are also many changes to the preview style; try out
\nblack --preview
and give us feedback to help us set the stable style for next year.In addition to style changes, Black now automatically infers the supported Python versions from your
\npyproject.toml
file, removing the need to set Black's target versions separately.Stable style
\n\n\n
\n- Introduce the 2023 stable style, which incorporates most aspects of last year's preview style (#3418). Specific changes:\n
\n\n
\n- Enforce empty lines before classes and functions with sticky leading comments (#3302) (22.12.0)
\n- Reformat empty and whitespace-only files as either an empty file (if no newline is present) or as a single newline character (if a newline is present) (#3348) (22.12.0)
\n- Correctly handle trailing commas that are inside a line's leading non-nested parens (#3370) (22.12.0)
\n- \n
--skip-string-normalization
/-S
now prevents docstring prefixes from being normalized as expected (#3168) (since 22.8.0)- When using
\n--skip-magic-trailing-comma
or-C
, trailing commas are stripped from subscript expressions with more than 1 element (#3209) (22.8.0)- Fix a string merging/split issue when a comment is present in the middle of implicitly concatenated strings on its own line (#3227) (22.8.0)
\n- Docstring quotes are no longer moved if it would violate the line length limit (#3044, #3430) (22.6.0)
\n- Parentheses around return annotations are now managed (#2990) (22.6.0)
\n- Remove unnecessary parentheses around awaited objects (#2991) (22.6.0)
\n- Remove unnecessary parentheses in
\nwith
statements (#2926) (22.6.0)- Remove trailing newlines after code block open (#3035) (22.6.0)
\n- Code cell separators
\n#%%
are now standardised to# %%
(#2919) (22.3.0)- Remove unnecessary parentheses from
\nexcept
statements (#2939) (22.3.0)- Remove unnecessary parentheses from tuple unpacking in
\nfor
loops (#2945) (22.3.0)- Avoid magic-trailing-comma in single-element subscripts (#2942) (22.3.0)
\n- Fix a crash when a colon line is marked between
\n# fmt: off
and# fmt: on
(#3439)Preview style
\n\n\n
\n\n- Format hex codes in unicode escape sequences in string literals (#2916)
\n- Add parentheses around
\nif
-else
expressions (#2278)- Improve performance on large expressions that contain many strings (#3467)
\n- Fix a crash in preview style with assert + parenthesized string (#3415)
\n- Fix crashes in preview style with walrus operators used in function return annotations and except clauses (#3423)
\n- Fix a crash in preview advanced string processing where mixed implicitly concatenated regular and f-strings start with an empty span (#3463)
\n- Fix a crash in preview advanced string processing where a standalone comment is placed before a dict's value (#3469)
\n- Fix an issue where extra empty lines are added when a decorator has
\n# fmt: skip
applied or there is a standalone comment between decorators (#3470)- Do not put the closing quotes in a docstring on a separate line, even if the line is too long (#3430)
\n- Long values in dict literals are now wrapped in parentheses; correspondingly unnecessary parentheses around short values in dict literals are now removed; long string lambda values are now wrapped in parentheses (#3440)
\n- Fix two crashes in preview style involving edge cases with docstrings (#3451)
\n- Exclude string type annotations from improved string processing; fix crash when the return type annotation is stringified and spans across multiple lines (#3462)
\n- Wrap multiple context managers in parentheses when targeting Python 3.9+ (#3489)
\n- Fix several crashes in preview style with walrus operators used in
\nwith
statements or tuples (#3473)- Fix an invalid quote escaping bug in f-string expressions where it produced invalid code. Implicitly concatenated f-strings with different quotes can now be merged or quote-normalized by changing the quotes used in expressions. (#3509)
\n
... (truncated)
\nSourced from black's changelog.
\n\n\n23.1.0
\nHighlights
\nThis is the first release of 2023, and following our\nstability policy,\nit comes with a number of improvements to our stable style, including improvements to\nempty line handling, removal of redundant parentheses in several contexts, and output\nthat highlights implicitly concatenated strings better.
\nThere are also many changes to the preview style; try out
\nblack --preview
and give us\nfeedback to help us set the stable style for next year.In addition to style changes, Black now automatically infers the supported Python\nversions from your
\npyproject.toml
file, removing the need to set Black's target\nversions separately.Stable style
\n\n\n
\n\n- Introduce the 2023 stable style, which incorporates most aspects of last year's\npreview style (#3418). Specific changes:\n
\n\n
\n- Enforce empty lines before classes and functions with sticky leading comments\n(#3302) (22.12.0)
\n- Reformat empty and whitespace-only files as either an empty file (if no newline is\npresent) or as a single newline character (if a newline is present) (#3348)\n(22.12.0)
\n- Implicitly concatenated strings used as function args are now wrapped inside\nparentheses (#3307) (22.12.0)
\n- Correctly handle trailing commas that are inside a line's leading non-nested parens\n(#3370) (22.12.0)
\n- \n
--skip-string-normalization
/-S
now prevents docstring prefixes from being\nnormalized as expected (#3168) (since 22.8.0)- When using
\n--skip-magic-trailing-comma
or-C
, trailing commas are stripped from\nsubscript expressions with more than 1 element (#3209) (22.8.0)- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside\nparentheses (#3162) (22.8.0)
\n- Fix a string merging/split issue when a comment is present in the middle of\nimplicitly concatenated strings on its own line (#3227) (22.8.0)
\n- Docstring quotes are no longer moved if it would violate the line length limit\n(#3044, #3430) (22.6.0)
\n- Parentheses around return annotations are now managed (#2990) (22.6.0)
\n- Remove unnecessary parentheses around awaited objects (#2991) (22.6.0)
\n- Remove unnecessary parentheses in
\nwith
statements (#2926) (22.6.0)- Remove trailing newlines after code block open (#3035) (22.6.0)
\n- Code cell separators
\n#%%
are now standardised to# %%
(#2919) (22.3.0)- Remove unnecessary parentheses from
\nexcept
statements (#2939) (22.3.0)- Remove unnecessary parentheses from tuple unpacking in
\nfor
loops (#2945) (22.3.0)- Avoid magic-trailing-comma in single-element subscripts (#2942) (22.3.0)
\n
... (truncated)
\nb0d1fba
Prepare release 23.1.0 (#3536)69ca0a4
Infer target version based on project metadata (#3219)c4bd2e3
Draft for Black 2023 stable style (#3418)226cbf0
Fix unsafe cast in linegen.py w/ await yield handling (#3533)f4ebc68
Upgrade isort (#3534)6407ebb
Remove Python version in the_basics.md (#3528)196b1f3
Fix black --help
output for --python-cell-magics
option to be reproducibl...d950f15
Update document now that paren wrapping CMs on Python 3.9+ is implemented (#3...a36878e
Fix an invalid quote escaping bug in f-string expressions (#3509)eabff67
Format hex code in unicode escape sequences in string literals (#2916)Sourced from blacken-docs's changelog.
\n\n\n1.13.0 (2023-01-16)
\n\n
\n- \n
\nNote Adam Johnson is new maintainer.
\n- \n
\nRequire Black 22.1.0+.
\n- \n
\nAdd
\n--rst-literal-blocks
option, to also format text in reStructuredText literal blocks, starting with::
.\nSphinx highlights these with the project\u2019s default language, which defaults to Python.
1238e1d
Version 1.13.04e6dc07
Fix setup.cfg long_description_content_type579a71a
Standardize setup.cfg (#212)a6b2ba0
Changelog entry about change in maintenance3cf8b9a
Standard pre-commit config (#211)bcd3669
Standardize test file name (#210)6d1771d
Remove setup.py (#209)4e5ab6e
Improve README (#208)c19c57f
Add support for reStructuredText literal blocks (#196)6af8099
Move from tmpdir pytest fixture to tmp_path (#206)Sourced from sphinx's releases.
\n\n\nv6.1.3
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 6.1.3 (released Jan 10, 2023)
\nBugs fixed
\n\n
776d01e
Bump to 6.1.3 finala2e922a
CHANGES for Sphinx 6.1.331162a9
Handle exceptions for get_node_source
and get_node_line
dcb4429
Restore Sphinx 5 nodes.Element
copying behaviour2a7c40d
Undo parallel image changes7841d3d
Ignore more checks in Ruff 0.0.214ddbc5b5
Bump versionSourced from sphinx's releases.
\n\n\nv6.1.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.1.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0b2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0b1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 6.1.2 (released Jan 07, 2023)
\nBugs fixed
\n\n
\n- \n
\n#11101: LaTeX:
\ndiv.topic_padding
key of sphinxsetup documented at 5.1.0 was\nimplemented with nametopic_padding
- \n
\n#11099: LaTeX:
\nshadowrule
key of sphinxsetup causes PDF build to crash\nsince Sphinx 5.1.0- \n
\n#11096: LaTeX:
\nshadowsize
key of sphinxsetup causes PDF build to crash\nsince Sphinx 5.1.0- \n
\n#11095: LaTeX: shadow of :dudir:
\ntopic
and contents_ boxes not in page\nmargin since Sphinx 5.1.0.. _contents: https://docutils.sourceforge.io/docs/ref/rst/directives.html#table-of-contents
\n- \n
\n#11100: Fix copying images when running under parallel mode.
\nRelease 6.1.1 (released Jan 05, 2023)
\nBugs fixed
\n\n
\n- #11091: Fix
\nutil.nodes.apply_source_workaround
forliteral_block
nodes\nwith no source information in the node or the node's parents.Release 6.1.0 (released Jan 05, 2023)
\nDependencies
\n\n
\n- \n
\nAdopted the
\nRuff
_ code linter... _Ruff: https://github.com/charliermarsh/ruff
\nIncompatible changes
\n\n
\n- #10979: gettext: Removed support for pluralisation in
\nget_translation
.\nThis was unused and complicated other changes tosphinx.locale
.Deprecated
\n\n
\n\n- \n
\n\n
sphinx.util
functions:\n
\n- Renamed
\nsphinx.util.typing.stringify()
\ntosphinx.util.typing.stringify_annotation()
... (truncated)
\n393b408
Bump to 6.1.2 finald8a5dd8
Add note to CHANGES for PR 11100a1cd19e
Fix copying images under parallel execution (#11100)5008291
Ignore more checks in Ruff 0.0.2136259c2b
Markup typo in docs7945aeb
LaTeX: fix 5.1.0 bugs related to topic and contents boxes (#11102)77aaa86
Bump to 6.1.1 final476c115
Suppress ValueError
in apply_source_workaround
(#11092)c80d656
Bump version4e1004a
Bump to 6.1.0 finalSourced from sphinx's releases.
\n\n\nv6.1.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0b2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0b1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 6.1.1 (released Jan 05, 2023)
\nBugs fixed
\n\n
\n- #11091: Fix
\nutil.nodes.apply_source_workaround
forliteral_block
nodes\nwith no source information in the node or the node's parents.Release 6.1.0 (released Jan 05, 2023)
\nDependencies
\n\n
\n- \n
\nAdopted the
\nRuff
_ code linter... _Ruff: https://github.com/charliermarsh/ruff
\nIncompatible changes
\n\n
\n- #10979: gettext: Removed support for pluralisation in
\nget_translation
.\nThis was unused and complicated other changes tosphinx.locale
.Deprecated
\n\n
\n\n- \n
\n\n
sphinx.util
functions:\n
\n- Renamed
\nsphinx.util.typing.stringify()
\ntosphinx.util.typing.stringify_annotation()
- Moved
\nsphinx.util.xmlname_checker()
\ntosphinx.builders.epub3._XML_NAME_PATTERN
Moved to
\nsphinx.util.display
:\n
\n- \n
sphinx.util.status_iterator
- \n
sphinx.util.display_chunk
- \n
sphinx.util.SkipProgressMessage
- \n
sphinx.util.progress_message
Moved to
\nsphinx.util.http_date
:\n
\n- \n
sphinx.util.epoch_to_rfc1123
- \n
sphinx.util.rfc1123_to_epoch
Moved to
\nsphinx.util.exceptions
:\n
\n- \n
sphinx.util.save_traceback
... (truncated)
\n77aaa86
Bump to 6.1.1 final476c115
Suppress ValueError
in apply_source_workaround
(#11092)c80d656
Bump version4e1004a
Bump to 6.1.0 finala2176d4
Fix deprecation warnings2c104e9
Merge branch '6.0.x'a27d262
Bump to 6.0.1 final821569e
Add note for Pygments222d366
imgmath: Fix relative file path (#10965)c499f66
Add SIM113 lint (#11057)Sourced from sphinx's releases.
\n\n\nv6.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0b2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0b1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 6.1.0 (released Jan 05, 2023)
\nDependencies
\n\n
\n- \n
\nAdopted the
\nRuff
_ code linter... _Ruff: https://github.com/charliermarsh/ruff
\nIncompatible changes
\n\n
\n- #10979: gettext: Removed support for pluralisation in
\nget_translation
.\nThis was unused and complicated other changes tosphinx.locale
.Deprecated
\n\n
\n- \n
\n\n
sphinx.util
functions:\n
\n- Renamed
\nsphinx.util.typing.stringify()
\ntosphinx.util.typing.stringify_annotation()
- Moved
\nsphinx.util.xmlname_checker()
\ntosphinx.builders.epub3._XML_NAME_PATTERN
Moved to
\nsphinx.util.display
:\n
\n- \n
sphinx.util.status_iterator
- \n
sphinx.util.display_chunk
- \n
sphinx.util.SkipProgressMessage
- \n
sphinx.util.progress_message
Moved to
\nsphinx.util.http_date
:\n
\n- \n
sphinx.util.epoch_to_rfc1123
- \n
sphinx.util.rfc1123_to_epoch
Moved to
\nsphinx.util.exceptions
:\n
\n- \n
sphinx.util.save_traceback
- \n
sphinx.util.format_exception_cut_frames
Features added
\n\n
\n\n- Cache doctrees in the build environment during the writing phase.
\n- Make all writing phase tasks support parallel execution.
\n- #11072: Use PEP 604 (
\nX | Y
) display conventions fortyping.Optional
\nandtyping.Optional
types within the Python domain and autodoc.
... (truncated)
\n4e1004a
Bump to 6.1.0 finala2176d4
Fix deprecation warnings2c104e9
Merge branch '6.0.x'a27d262
Bump to 6.0.1 final821569e
Add note for Pygments222d366
imgmath: Fix relative file path (#10965)c499f66
Add SIM113 lint (#11057)0fbd8af
Add missing default arguments in sphinx-apidoc.rst (#11084)f89f943
Remove flake8 plugins in favour of Ruff (#11085)0479115
Suppress lint failures from Ruff 0.0.211 (#11086)Sourced from sphinx's releases.
\n\n\nv6.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0b2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.0.0b1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 6.0.0 (released Dec 29, 2022)
\nDependencies
\n\n
\n- #10468: Drop Python 3.6 support
\n- #10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and\nDocutils 0.17 support. Patch by Adam Turner
\nIncompatible changes
\n\n
\n- \n
\n#7405: Removed the jQuery and underscore.js JavaScript frameworks.
\nThese frameworks are no longer be automatically injected into themes from\nSphinx 6.0. If you develop a theme or extension that uses the\n
\njQuery
,$
, or$u
global objects, you need to update your\nJavaScript to modern standards, or use the mitigation below.The first option is to use the sphinxcontrib.jquery_ extension, which has been\ndeveloped by the Sphinx team and contributors. To use this, add\n
\nsphinxcontrib.jquery
to theextensions
list inconf.py
, or call\napp.setup_extension("sphinxcontrib.jquery")
if you develop a Sphinx theme\nor extension.The second option is to manually ensure that the frameworks are present.\nTo re-add jQuery and underscore.js, you will need to copy
\njquery.js
and\nunderscore.js
fromthe Sphinx repository
_ to yourstatic
directory,\nand add the following to yourlayout.html
:.. code-block:: html+jinja
\n{%- block scripts %}\n\n\n{{ super() }}\n{%- endblock %}
\n.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/
\nPatch by Adam Turner.
\n- \n
\n#10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See\n:ref:
\ndev-deprecated-apis
for details. Patch by Adam Turner.- \n
\n#10901: C Domain: Remove support for parsing pre-v3 style type directives and\nroles. Also remove associated configuration variables
\nc_allow_pre_v3
and\nc_warn_on_allowed_pre_v3
. Patch by Adam Turner.Features added
\n\n
... (truncated)
\n5b56a23
Bump to 6.0.0 finalf1d1e9c
Update coverage workflow for Tox 466a738c
Update coverage workflow for new configuration location041e5f8
Add test coverage for 'today_fmt' reference substitution (#10980)da25145
Remove unnecessary conditional import in sphinx.ext.napoleon
(#11043)45a0ea9
Migrate coveragepy config into pyproject.toml (#11025)3ec54f1
Create a pydata_sphinx_theme
section in usage examples (#11046)32bce8f
Copy edit the tutorial (#11049)9844162
Fix example using add_config_value
(#10937)bf4a626
RTD builder: add graphviz depedendency (#11040)Sourced from black's releases.
\n\n\n22.12.0
\nPreview style
\n\n\n
\n- Enforce empty lines before classes and functions with sticky leading comments (#3302)
\n- Reformat empty and whitespace-only files as either an empty file (if no newline is\npresent) or as a single newline character (if a newline is present) (#3348)
\n- Implicitly concatenated strings used as function args are now wrapped inside\nparentheses (#3307)
\n- Correctly handle trailing commas that are inside a line's leading non-nested parens\n(#3370)
\nConfiguration
\n\n\n
\n- Fix incorrectly applied
\n.gitignore
rules by considering the.gitignore
location\nand the relative path to the target file (#3338)- Fix incorrectly ignoring
\n.gitignore
presence when more than one source directory is\nspecified (#3336)Parser
\n\n\n
\n- Parsing support has been added for walruses inside generator expression that are\npassed as function args (for example,\n
\nany(match := my_re.match(text) for text in texts)
) (#3327).Integrations
\n\n\n
\n- Vim plugin: Optionally allow using the system installation of Black via\n
\nlet g:black_use_virtualenv = 0
(#3309)
Sourced from black's changelog.
\n\n\n22.12.0
\nPreview style
\n\n\n
\n- Enforce empty lines before classes and functions with sticky leading comments (#3302)
\n- Reformat empty and whitespace-only files as either an empty file (if no newline is\npresent) or as a single newline character (if a newline is present) (#3348)
\n- Implicitly concatenated strings used as function args are now wrapped inside\nparentheses (#3307)
\n- Correctly handle trailing commas that are inside a line's leading non-nested parens\n(#3370)
\nConfiguration
\n\n\n
\n- Fix incorrectly applied
\n.gitignore
rules by considering the.gitignore
location\nand the relative path to the target file (#3338)- Fix incorrectly ignoring
\n.gitignore
presence when more than one source directory is\nspecified (#3336)Parser
\n\n\n
\n- Parsing support has been added for walruses inside generator expression that are\npassed as function args (for example,\n
\nany(match := my_re.match(text) for text in texts)
) (#3327).Integrations
\n\n\n
\n- Vim plugin: Optionally allow using the system installation of Black via\n
\nlet g:black_use_virtualenv = 0
(#3309)
2ddea29
Prepare release 22.12.0 (#3413)5b1443a
release: skip bad macos wheels for now (#3411)9ace064
Bump peter-evans/find-comment from 2.0.1 to 2.1.0 (#3404)19c5fe4
Fix CI with latest flake8-bugbear (#3412)d4a8564
Bump sphinx-copybutton from 0.5.0 to 0.5.1 in /docs (#3390)2793249
Wordsmith current_style.md (#3383)d97b789
Remove whitespaces of whitespace-only files (#3348)c23a5c1
Clarify that Black runs with --safe by default (#3378)8091b25
Correctly handle trailing commas that are inside a line's leading non-nested ...ffaaf48
Compare each .gitignore found with an appropiate relative path (#3338)Sourced from furo's changelog.
\n\n\nChangelog
\n\n2022.12.07 -- Reverent Raspberry
\n\n
\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n- Drop support for Sphinx 4.
\n- Improve documentation about what the edit button does.
\n- Improve handling of empty-flexboxes for better print experience on Chrome.
\n- Improve styling for inline signatures.
\n- Replace the
\nmeta
generator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
\n2022.09.29 -- Quaint Quartz
\n\n
\n- Add ability to set arbitrary URLs for edit button.
\n- Add support for aligning text in MyST-parser generated tables.
\n2022.09.15 -- Pragmatic Pistachio
\n\n
\n- Add a minimum version constraint on pygments.
\n- Add an explicit dependency on
\nsass
.- Change right sidebar title from "Contents" to "On this page".
\n- Correctly position sidebars on small screens.
\n- Correctly select only Furo's own
\nsvg
in related pagesnav
.- Make numpy-style documentation headers consistent.
\n- Retitle the reference section.
\n- Update npm dependencies.
\n2022.06.21 -- Opulent Opal
\n\n
\n- Fix
\ndocutils <= 0.17.x
compatibility.- Bump to the latest Node.js LTS.
\n2022.06.04.1 -- Naughty Nickel bugfix
\n\n
\n- Fix the URL used in the "Edit this page" for Read the Docs builds.
\n2022.06.04 -- Naughty Nickel
\n\n
... (truncated)
\n1034267
Prepare release: 2022.12.07239e69f
Update changelog8faac34
Remove the no-longer-useful gh-pages workflowfaa27fb
Fix the hyperlink warning9849ec0
Forward the arguments to stb serve
e0dc9b8
[pre-commit.ci] pre-commit autoupdate (#588)9842e25
Clarify what the edit button does (#587)0d2cf0b
[pre-commit.ci] pre-commit autoupdate (#578)b7d8866
Revert "Document that GCC is using Furo! (#575)" (#577)0ab12bb
Improve footnote presentation with docutils 0.18+ (#576)Sourced from black's releases.
\n\n\n22.10.0
\nHighlights
\n\n
\n- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be\nsupported until further notice.
\nStable style
\n\n
\n- Fix a crash when
\n# fmt: on
is used on a different block level than# fmt: off
\n(#3281)Preview style
\n\n
\n- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys\n(#3262)
\nConfiguration
\n\n
\n- \n
.ipynb_checkpoints
directories are now excluded by default (#3293)- Add
\n--skip-source-first-line
/-x
option to ignore the first line of source code\nwhile formatting (#3299)Packaging
\n\n
\n- Executables made with PyInstaller will no longer crash when formatting several files\nat once on macOS. Native x86-64 executables for macOS are available once again.\n(#3275)
\n- Hatchling is now used as the build backend. This will not have any effect for users\nwho install Black with its wheels from PyPI. (#3233)
\n- Faster compiled wheels are now available for CPython 3.11 (#3276)
\nBlackd
\n\n
\n- Windows style (CRLF) newlines will be preserved (#3257).
\nIntegrations
\n\n
Sourced from black's changelog.
\n\n\n22.10.0
\nHighlights
\n\n
\n- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be\nsupported until further notice.
\nStable style
\n\n
\n- Fix a crash when
\n# fmt: on
is used on a different block level than# fmt: off
\n(#3281)Preview style
\n\n
\n- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys\n(#3262)
\nConfiguration
\n\n
\n- \n
.ipynb_checkpoints
directories are now excluded by default (#3293)- Add
\n--skip-source-first-line
/-x
option to ignore the first line of source code\nwhile formatting (#3299)Packaging
\n\n
\n- Executables made with PyInstaller will no longer crash when formatting several files\nat once on macOS. Native x86-64 executables for macOS are available once again.\n(#3275)
\n- Hatchling is now used as the build backend. This will not have any effect for users\nwho install Black with its wheels from PyPI. (#3233)
\n- Faster compiled wheels are now available for CPython 3.11 (#3276)
\nBlackd
\n\n
\n- Windows style (CRLF) newlines will be preserved (#3257).
\nIntegrations
\n\n
27d2014
Prepare release 22.10.0 (#3311)4da0851
Add option to skip the first line of source code (#3299)0359b85
Preserve crlf line endings in blackd (#3257)27d7ea4
Bump docutils from 0.18.1 to 0.19 in /docs (#3161)1a20c4d
Bump sphinx from 5.2.1 to 5.2.3 in /docs (#3305)980997f
Bump furo from 2022.9.15 to 2022.9.29 in /docs (#3304)b1077aa
Bump myst-parser from 0.18.0 to 0.18.1 in /docs (#3303)956bf39
Add .ipynb_checkpoints to DEFAULT_EXCLUDES (#3293)141291a
Enable build isolation under CIWB (#3297)ddb9924
Bump pypa/cibuildwheel from 2.10.0 to 2.10.2 (#3290)Sourced from furo's changelog.
\n\n\nChangelog
\n\n2022.09.29 -- Quaint Quartz
\n\n
\n- Add ability to set arbitrary URLs for edit button.
\n- Add support for aligning text in MyST-parser generated tables.
\n2022.09.15 -- Pragmatic Pistachio
\n\n
\n- Add a minimum version constraint on pygments.
\n- Add an explicit dependency on
\nsass
.- Change right sidebar title from "Contents" to "On this page".
\n- Correctly position sidebars on small screens.
\n- Correctly select only Furo's own
\nsvg
in related pagesnav
.- Make numpy-style documentation headers consistent.
\n- Retitle the reference section.
\n- Update npm dependencies.
\n2022.06.21 -- Opulent Opal
\n\n
\n- Fix
\ndocutils <= 0.17.x
compatibility.- Bump to the latest Node.js LTS.
\n2022.06.04.1 -- Naughty Nickel bugfix
\n\n
\n- Fix the URL used in the "Edit this page" for Read the Docs builds.
\n2022.06.04 -- Naughty Nickel
\n\n
\n- \u2728 Advertise Sphinx 5 compatibility.
\n- \u2728 Change to
\nbasic-ng
as the base theme (from {pypi}sphinx-basic-ng
).- Document site-wide announcement banners.
\n- Drop the pin on pygments.
\n- Improve edit button, using
\nbasic-ng
'sedit-this-page
component.- Tweak headings to better match what users expect.
\n- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
\n- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.
\n2022.04.07 -- Magical Mauve
\n\n
... (truncated)
\n1375f9d
Prepare release: 2022.09.29af43607
Update changelogbc0fe52
Update user-facing documentation for edit button509c558
Modernise the edit-this-page.html
template5a0ceca
Add source_edit_link
as a theme configuration parameter (#510)52fc32f
Build documentation in pull requests149f77b
Fix stylesheet for MyST tables9af2e44
Support MyST table column alignment (#531)82dd61c
Back to development