Sourced from black's releases.
21.4b0
Black
Fixed a rare but annoying formatting instability created by the combination of optional trailing commas inserted by
Blackand optional parentheses looking at pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many duplicates. (#2126)
Blacknow processes one-line docstrings by stripping leading and trailing spaces, and adding a padding space when needed to break up """". (#1740)
Blacknow cleans up leading non-breaking spaces in comments (#2092)
Blacknow respects--skip-string-normalizationwhen normalizing multiline docstring quotes (#1637)
Blackno longer removes all empty lines between non-function code and decorators when formatting typing stubs. NowBlackenforces a single empty line. (#1646)
Blackno longer adds an incorrect space after a parenthesized assignment expression in if/while statements (#1655)Added
--skip-magic-trailing-comma/-Cto avoid using trailing commas as a reason to split lines (#1824)fixed a crash when PWD=/ on POSIX (#1631)
fixed "I/O operation on closed file" when using --diff (#1664)
Prevent coloured diff output being interleaved with multiple files (#1673)
Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
Added parsing support for unparenthesized tuples and yield expressions in annotated assignments (#1835)
use lowercase hex strings (#1692)
added
--extend-excludeargument (PR #2005)speed up caching by avoiding pathlib (#1950)
--diffcorrectly indicates when a file doesn't end in a newline (#1662)Added
--stdin-filenameargument to allow stdin to respect--force-excluderules (#1780)Lines ending with
fmt: skipwill now be not formatted (#1800)PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
... (truncated)
Sourced from black's changelog.
21.4b0
Black
Fixed a rare but annoying formatting instability created by the combination of optional trailing commas inserted by
Blackand optional parentheses looking at pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many duplicates. (#2126)
Blacknow processes one-line docstrings by stripping leading and trailing spaces, and adding a padding space when needed to break up """". (#1740)
Blacknow cleans up leading non-breaking spaces in comments (#2092)
Blacknow respects--skip-string-normalizationwhen normalizing multiline docstring quotes (#1637)
Blackno longer removes all empty lines between non-function code and decorators when formatting typing stubs. NowBlackenforces a single empty line. (#1646)
Blackno longer adds an incorrect space after a parenthesized assignment expression in if/while statements (#1655)Added
--skip-magic-trailing-comma/-Cto avoid using trailing commas as a reason to split lines (#1824)fixed a crash when PWD=/ on POSIX (#1631)
fixed "I/O operation on closed file" when using --diff (#1664)
Prevent coloured diff output being interleaved with multiple files (#1673)
Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
Added parsing support for unparenthesized tuples and yield expressions in annotated assignments (#1835)
added
--extend-excludeargument (PR #2005)speed up caching by avoiding pathlib (#1950)
--diffcorrectly indicates when a file doesn't end in a newline (#1662)Added
--stdin-filenameargument to allow stdin to respect--force-excluderules (#1780)Lines ending with
fmt: skipwill now be not formatted (#1800)PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
... (truncated)
Sourced from black's releases.
21.4b1
Black
Fix crash on docstrings ending with "\ ". (#2142)
Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
Reflect the
--skip-magic-trailing-commaand--experimental-string-processingflags in the name of the cache file. Without this fix, changes in these flags would not take effect if the cache had already been populated. (#2131)Don't remove necessary parentheses from assignment expression containing assert / return statements. (#2143)
Packaging
- Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
21.4b0
Black
Fixed a rare but annoying formatting instability created by the combination of optional trailing commas inserted by
Blackand optional parentheses looking at pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many duplicates. (#2126)
Blacknow processes one-line docstrings by stripping leading and trailing spaces, and adding a padding space when needed to break up """". (#1740)
Blacknow cleans up leading non-breaking spaces in comments (#2092)
Blacknow respects--skip-string-normalizationwhen normalizing multiline docstring quotes (#1637)
Blackno longer removes all empty lines between non-function code and decorators when formatting typing stubs. NowBlackenforces a single empty line. (#1646)
Blackno longer adds an incorrect space after a parenthesized assignment expression in if/while statements (#1655)Added
--skip-magic-trailing-comma/-Cto avoid using trailing commas as a reason to split lines (#1824)fixed a crash when PWD=/ on POSIX (#1631)
fixed "I/O operation on closed file" when using --diff (#1664)
Prevent coloured diff output being interleaved with multiple files (#1673)
Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
... (truncated)
Sourced from black's changelog.
21.4b1
Black
Fix crash on docstrings ending with "\ ". (#2142)
Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
Reflect the
--skip-magic-trailing-commaand--experimental-string-processingflags in the name of the cache file. Without this fix, changes in these flags would not take effect if the cache had already been populated. (#2131)Don't remove necessary parentheses from assignment expression containing assert / return statements. (#2143)
Packaging
- Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
21.4b0
Black
Fixed a rare but annoying formatting instability created by the combination of optional trailing commas inserted by
Blackand optional parentheses looking at pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many duplicates. (#2126)
Blacknow processes one-line docstrings by stripping leading and trailing spaces, and adding a padding space when needed to break up """". (#1740)
Blacknow cleans up leading non-breaking spaces in comments (#2092)
Blacknow respects--skip-string-normalizationwhen normalizing multiline docstring quotes (#1637)
Blackno longer removes all empty lines between non-function code and decorators when formatting typing stubs. NowBlackenforces a single empty line. (#1646)
Blackno longer adds an incorrect space after a parenthesized assignment expression in if/while statements (#1655)Added
--skip-magic-trailing-comma/-Cto avoid using trailing commas as a reason to split lines (#1824)fixed a crash when PWD=/ on POSIX (#1631)
fixed "I/O operation on closed file" when using --diff (#1664)
Prevent coloured diff output being interleaved with multiple files (#1673)
... (truncated)
Sourced from black's releases.
21.4b2
Black
Fix crash if the user configuration directory is inaccessible. (#2158)
Clarify circumstances in which Black may change the AST (#2159)
Packaging
- Install
primer.json(used byblack-primerby default) with black. (#2154)21.4b1
Black
Fix crash on docstrings ending with "\ ". (#2142)
Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
Reflect the
--skip-magic-trailing-commaand--experimental-string-processingflags in the name of the cache file. Without this fix, changes in these flags would not take effect if the cache had already been populated. (#2131)Don't remove necessary parentheses from assignment expression containing assert / return statements. (#2143)
Packaging
- Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
21.4b0
Black
Fixed a rare but annoying formatting instability created by the combination of optional trailing commas inserted by
Blackand optional parentheses looking at pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many duplicates. (#2126)
Blacknow processes one-line docstrings by stripping leading and trailing spaces, and adding a padding space when needed to break up """". (#1740)
Blacknow cleans up leading non-breaking spaces in comments (#2092)
Blacknow respects--skip-string-normalizationwhen normalizing multiline docstring quotes (#1637)
Blackno longer removes all empty lines between non-function code and decorators when formatting typing stubs. NowBlackenforces a single empty line. (#1646)
... (truncated)
Sourced from black's changelog.
21.4b2
Black
Fix crash if the user configuration directory is inaccessible. (#2158)
Clarify circumstances in which Black may change the AST (#2159)
Packaging
- Install
primer.json(used byblack-primerby default) with black. (#2154)21.4b1
Black
Fix crash on docstrings ending with "\ ". (#2142)
Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
Reflect the
--skip-magic-trailing-commaand--experimental-string-processingflags in the name of the cache file. Without this fix, changes in these flags would not take effect if the cache had already been populated. (#2131)Don't remove necessary parentheses from assignment expression containing assert / return statements. (#2143)
Packaging
- Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
21.4b0
Black
Fixed a rare but annoying formatting instability created by the combination of optional trailing commas inserted by
Blackand optional parentheses looking at pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many duplicates. (#2126)
Blacknow processes one-line docstrings by stripping leading and trailing spaces, and adding a padding space when needed to break up """". (#1740)
Blacknow cleans up leading non-breaking spaces in comments (#2092)
Blacknow respects--skip-string-normalizationwhen normalizing multiline docstring quotes (#1637)
... (truncated)
Sourced from black's releases.
21.12b0
Black
- Fix determination of f-string expression spans (#2654)
- Fix bad formatting of error messages about EOF in multi-line statements (#2343)
- Functions and classes in blocks now have more consistent surrounding spacing (#2472)
Jupyter Notebook support
- Cell magics are now only processed if they are known Python cell magics. Earlier, all cell magics were tokenized, leading to possible indentation errors e.g. with
%%writefile. (#2630)- Fix assignment to environment variables in Jupyter Notebooks (#2642)
Python 3.10 support
- Point users to using
--target-version py310if we detect 3.10-only syntax (#2668)- Fix
matchstatements with open sequence subjects, likematch a, b:ormatch a, *b:(#2639) (#2659)- Fix
match/casestatements that containmatch/casesoft keywords multiple times, likematch re.match()(#2661)- Fix
casestatements with an inline body (#2665)- Fix styling of starred expressions inside
matchsubject (#2667)- Fix parser error location on invalid syntax in a
matchstatement (#2649)- Fix Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
- Improve parsing performance on code that uses
matchunder--target-version py310up to ~50% (#2670)Packaging
Thank you!
@isidenticalfor the polishing up 3.10 syntax support (which they contributed in the first place!)@MarcoGorellifor their ever-continuing work on Black's jupyter support@jalazizfor cleaning up our Pyinstaller CD workflow@hauntsaninjafor helping us drop theregexdependencyAnd also congrats to first contributors!
@MatthewScholefieldmade their first contribution in psf/black#2631@AshIsbittmade their first contribution in psf/black#2632@kalbasitmade their first contribution in psf/black#2638@danieleadesmade their first contribution in psf/black#2653@danielsparingmade their first contribution in psf/black#2630@tanvimoharirmade their first contribution in psf/black#2343
Sourced from black's changelog.
21.12b0
Black
- Fix determination of f-string expression spans (#2654)
- Fix bad formatting of error messages about EOF in multi-line statements (#2343)
- Functions and classes in blocks now have more consistent surrounding spacing (#2472)
Jupyter Notebook support
- Cell magics are now only processed if they are known Python cell magics. Earlier, all cell magics were tokenized, leading to possible indentation errors e.g. with
%%writefile. (#2630)- Fix assignment to environment variables in Jupyter Notebooks (#2642)
Python 3.10 support
- Point users to using
--target-version py310if we detect 3.10-only syntax (#2668)- Fix
matchstatements with open sequence subjects, likematch a, b:ormatch a, *b:(#2639) (#2659)- Fix
match/casestatements that containmatch/casesoft keywords multiple times, likematch re.match()(#2661)- Fix
casestatements with an inline body (#2665)- Fix styling of starred expressions inside
matchsubject (#2667)- Fix parser error location on invalid syntax in a
matchstatement (#2649)- Fix Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
- Improve parsing performance on code that uses
matchunder--target-version py310up to ~50% (#2670)Packaging
Sourced from black's releases.
22.1.0
At long last, Black is no longer a beta product! This is the first non-beta release and the first release covered by our new stability policy.
Highlights
Style
- Deprecate
--experimental-string-processingand move the functionality under--preview(#2789)- For stubs, one blank line between class attributes and methods is now kept if there's at least one pre-existing blank line (#2736)
- Black now normalizes string prefix order (#2297)
- Remove spaces around power operators if both operands are simple (#2726)
- Work around bug that causes unstable formatting in some cases in the presence of the magic trailing comma (#2807)
- Use parentheses for attribute access on decimal float and int literals (#2799)
- Don't add whitespace for attribute access on hexadecimal, binary, octal, and complex literals (#2799)
- Treat blank lines in stubs the same inside top-level if statements (#2820)
- Fix unstable formatting with semicolons and arithmetic expressions (#2817)
- Fix unstable formatting around magic trailing comma (#2572)
Parser
- Fix mapping cases that contain as-expressions, like
case {"key": 1 | 2 as password}(#2686)- Fix cases that contain multiple top-level as-expressions, like
case 1 as a, 2 as b(#2716)- Fix call patterns that contain as-expressions with keyword arguments, like
case Foo(bar=baz as quux)(#2749)- Tuple unpacking on
returnandyieldconstructs now implies 3.8+ (#2700)- Unparenthesized tuples on annotated assignments (e.g
values: Tuple[int, ...] = 1, 2, 3) now implies 3.8+ (#2708)- Fix handling of standalone
match()orcase()when there is a trailing newline or a comment inside of the parentheses. (#2760)from __future__ import annotationsstatement now implies Python 3.7+ (#2690)Performance
- Speed-up the new backtracking parser about 4X in general (enabled when
--target-versionis set to 3.10 and higher). (#2728)- Black is now compiled with mypyc for an overall 2x speed-up. 64-bit Windows, MacOS, and Linux (not including musl) are supported. (#1009, #2431)
Configuration
- Do not accept bare carriage return line endings in pyproject.toml (#2408)
- Add configuration option (
python-cell-magics) to format cells with custom magics in Jupyter Notebooks (#2744)- Allow setting custom cache directory on all platforms with environment variable
BLACK_CACHE_DIR(#2739).- Enable Python 3.10+ by default, without any extra need to specify -
-target-version=py310. (#2758)- Make passing
SRCor--codemandatory and mutually exclusive (#2804)Output
- Improve error message for invalid regular expression (#2678)
- Improve error message when parsing fails during AST safety check by embedding the underlying SyntaxError (#2693)
- No longer color diff headers white as it's unreadable in light themed terminals (#2691)
- Text coloring added in the final statistics (#2712)
- Verbose mode also now describes how a project root was discovered and which paths will be formatted. (#2526)
Packaging
... (truncated)
Sourced from black's changelog.
22.1.0
At long last, Black is no longer a beta product! This is the first non-beta release and the first release covered by our new stability policy.
Highlights
Style
- Deprecate
--experimental-string-processingand move the functionality under--preview(#2789)- For stubs, one blank line between class attributes and methods is now kept if there's at least one pre-existing blank line (#2736)
- Black now normalizes string prefix order (#2297)
- Remove spaces around power operators if both operands are simple (#2726)
- Work around bug that causes unstable formatting in some cases in the presence of the magic trailing comma (#2807)
- Use parentheses for attribute access on decimal float and int literals (#2799)
- Don't add whitespace for attribute access on hexadecimal, binary, octal, and complex literals (#2799)
- Treat blank lines in stubs the same inside top-level
ifstatements (#2820)- Fix unstable formatting with semicolons and arithmetic expressions (#2817)
- Fix unstable formatting around magic trailing comma (#2572)
Parser
- Fix mapping cases that contain as-expressions, like
case {"key": 1 | 2 as password}(#2686)- Fix cases that contain multiple top-level as-expressions, like
case 1 as a, 2 as b(#2716)- Fix call patterns that contain as-expressions with keyword arguments, like
case Foo(bar=baz as quux)(#2749)- Tuple unpacking on
returnandyieldconstructs now implies 3.8+ (#2700)- Unparenthesized tuples on annotated assignments (e.g
values: Tuple[int, ...] = 1, 2, 3) now implies 3.8+ (#2708)- Fix handling of standalone
match()orcase()when there is a trailing newline or a comment inside of the parentheses. (#2760)from __future__ import annotationsstatement now implies Python 3.7+ (#2690)Performance
... (truncated)
Sourced from black's releases.
21.5b0
Black
- Set
--pyimode if--stdin-filenameends in.pyi(#2169)- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are being called but with no arguments (#2182)
Black-Primer
- Add
--no-diffto black-primer to suppress formatting changes (#2187)
Sourced from black's changelog.
21.5b0
Black
- Set
--pyimode if--stdin-filenameends in.pyi(#2169)- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are being called but with no arguments (#2182)
Black-Primer
- Add
--no-diffto black-primer to suppress formatting changes (#2187)
Sourced from black's releases.
21.5b1
Black
- Refactor
src/black/__init__.pyinto many files (#2206)Documentation
- Replaced all remaining references to the
masterbranch with themainbranch. Some additional changes in the source code were also made. (#2210)- Sigificantly reorganized the documentation to make much more sense. Check them out by heading over to the stable docs on RTD. (#2174)
21.5b0
Black
- Set
--pyimode if--stdin-filenameends in.pyi(#2169)- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are being called but with no arguments (#2182)
Black-Primer
- Add
--no-diffto black-primer to suppress formatting changes (#2187)
Sourced from black's changelog.
21.5b1
Black
- Refactor
src/black/__init__.pyinto many files (#2206)Documentation
- Replaced all remaining references to the
masterbranch with themainbranch. Some additional changes in the source code were also made. (#2210)- Sigificantly reorganized the documentation to make much more sense. Check them out by heading over to the stable docs on RTD. (#2174)
21.5b0
Black
- Set
--pyimode if--stdin-filenameends in.pyi(#2169)- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are being called but with no arguments (#2182)
Black-Primer
- Add
--no-diffto black-primer to suppress formatting changes (#2187)
Sourced from black's releases.
21.5b2
Black
- A space is no longer inserted into empty docstrings (#2249)
- Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
- Respect
.gitignorefiles in all levels, not onlyroot/.gitignorefile (apply.gitignorerules likegitdoes) (#2225)- Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
- Add extra uvloop install + import support if in python env (#2258)
- Fix --experimental-string-processing crash when matching parens are not found (#2283)
- Make sure to split lines that start with a string operator (#2286)
- Fix regular expression that black uses to identify f-expressions (#2287)
Blackd
- Add a lower bound for the
aiohttp-corsdependency. Only 0.4.0 or higher is supported. (#2231)Packaging
- Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline (#2198)
- Always build binaries with the latest available Python (#2260)
Documentation
- Add discussion of magic comments to FAQ page (#2272)
--experimental-string-processingwill be enabled by default in the future (#2273)- Fix typos discovered by codespell (#2228)
- Fix Vim plugin installation instructions. (#2235)
- Add new Frequently Asked Questions page (#2247)
- Fix encoding + symlink issues preventing proper build on Windows (#2262)
Sourced from black's changelog.
21.5b2
Black
- A space is no longer inserted into empty docstrings (#2249)
- Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
- Respect
.gitignorefiles in all levels, not onlyroot/.gitignorefile (apply.gitignorerules likegitdoes) (#2225)- Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
- Add extra uvloop install + import support if in python env (#2258)
- Fix --experimental-string-processing crash when matching parens are not found (#2283)
- Make sure to split lines that start with a string operator (#2286)
- Fix regular expression that black uses to identify f-expressions (#2287)
Blackd
- Add a lower bound for the
aiohttp-corsdependency. Only 0.4.0 or higher is supported. (#2231)Integrations
- The official Black action now supports choosing what version to use, and supports the major 3 OSes. (#1940)
Packaging
- Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline (#2198)
- Always build binaries with the latest available Python (#2260)
Documentation
- Add discussion of magic comments to FAQ page (#2272)
--experimental-string-processingwill be enabled by default in the future (#2273)- Fix typos discovered by codespell (#2228)
- Fix Vim plugin installation instructions. (#2235)
- Add new Frequently Asked Questions page (#2247)
- Fix encoding + symlink issues preventing proper build on Windows (#2262)
Sourced from black's releases.
21.6b0
Black
- Fix failure caused by
fmt: skipand indentation (#2281)- Account for += assignment when deciding whether to split string (#2312)
- Correct max string length calculation when there are string operators (#2292)
- Fixed option usage when using the
--codeflag (#2259)- Do not call
uvloop.install()when Black is used as a library (#2303)- Added
--required-versionoption to require a specific version to be running (#2300)- Fix incorrect custom breakpoint indices when string group contains fake f-strings (#2311)
- Fix regression where
Rprefixes would be lowercased for docstrings (#2285)- Fix handling of named escapes (
\N{...}) when--experimental-string-processingis used (#2319)
Sourced from black's changelog.
21.6b0
Black
- Fix failure caused by
fmt: skipand indentation (#2281)- Account for += assignment when deciding whether to split string (#2312)
- Correct max string length calculation when there are string operators (#2292)
- Fixed option usage when using the
--codeflag (#2259)- Do not call
uvloop.install()when Black is used as a library (#2303)- Added
--required-versionoption to require a specific version to be running (#2300)- Fix incorrect custom breakpoint indices when string group contains fake f-strings (#2311)
- Fix regression where
Rprefixes would be lowercased for docstrings (#2285)- Fix handling of named escapes (
\N{...}) when--experimental-string-processingis used (#2319)
Sourced from black's releases.
21.7b0
Black
- Configuration files using TOML features higher than spec v0.5.0 are now supported (#2301)
- Add primer support and test for code piped into black via STDIN (#2315)
- Fix internal error when
FORCE_OPTIONAL_PARENTHESESfeature is enabled (#2332)- Accept empty stdin (#2346)
- Provide a more useful error when parsing fails during AST safety checks (#2304)
Docker
- Add new
latest_releasetag automation to follow latest black release on docker images (#2374)Integrations
- The vim plugin now searches upwards from the directory containing the current buffer instead of the current working directory for pyproject.toml. (#1871)
- The vim plugin now reads the correct string normalization option in pyproject.toml (#1869)
- The vim plugin no longer crashes Black when there's boolean values in pyproject.toml (#1869)
Sourced from black's changelog.
21.7b0
Black
- Configuration files using TOML features higher than spec v0.5.0 are now supported (#2301)
- Add primer support and test for code piped into black via STDIN (#2315)
- Fix internal error when
FORCE_OPTIONAL_PARENTHESESfeature is enabled (#2332)- Accept empty stdin (#2346)
- Provide a more useful error when parsing fails during AST safety checks (#2304)
Docker
- Add new
latest_releasetag automation to follow latest black release on docker images (#2374)Integrations
- The vim plugin now searches upwards from the directory containing the current buffer instead of the current working directory for pyproject.toml. (#1871)
- The vim plugin now reads the correct string normalization option in pyproject.toml (#1869)
- The vim plugin no longer crashes Black when there's boolean values in pyproject.toml (#1869)
Sourced from black's releases.
21.8b0
Black
- Add support for formatting Jupyter Notebook files (#2357)
- Move from
appdirsdependency toplatformdirs(#2375)- Present a more user-friendly error if .gitignore is invalid (#2414)
- The failsafe for accidentally added backslashes in f-string expressions has been hardened to handle more edge cases during quote normalization (#2437)
- Avoid changing a function return type annotation's type to a tuple by adding a trailing comma (#2384)
- Parsing support has been added for unparenthesized walruses in set literals, set comprehensions, and indices (#2447).
- Pin
setuptools-scmbuild-time dependency version (#2457)- Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10 (#2460)
Blackd
- Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that scan installed packages (#2440)
Integrations
- The provided pre-commit hooks no longer specify
language_versionto avoid overridingdefault_language_version(#2430)
Sourced from black's changelog.
21.8b0
Black
- Add support for formatting Jupyter Notebook files (#2357)
- Move from
appdirsdependency toplatformdirs(#2375)- Present a more user-friendly error if .gitignore is invalid (#2414)
- The failsafe for accidentally added backslashes in f-string expressions has been hardened to handle more edge cases during quote normalization (#2437)
- Avoid changing a function return type annotation's type to a tuple by adding a trailing comma (#2384)
- Parsing support has been added for unparenthesized walruses in set literals, set comprehensions, and indices (#2447).
- Pin
setuptools-scmbuild-time dependency version (#2457)- Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10 (#2460)
Blackd
- Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that scan installed packages (#2440)
Integrations
- The provided pre-commit hooks no longer specify
language_versionto avoid overridingdefault_language_version(#2430)
Sourced from black's releases.
21.9b0
Packaging
- Fix missing modules in self-contained binaries (#2466)
- Fix missing toml extra used during installation (#2475)
21.8b0
Black
- Add support for formatting Jupyter Notebook files (#2357)
- Move from
appdirsdependency toplatformdirs(#2375)- Present a more user-friendly error if .gitignore is invalid (#2414)
- The failsafe for accidentally added backslashes in f-string expressions has been hardened to handle more edge cases during quote normalization (#2437)
- Avoid changing a function return type annotation's type to a tuple by adding a trailing comma (#2384)
- Parsing support has been added for unparenthesized walruses in set literals, set comprehensions, and indices (#2447).
- Pin
setuptools-scmbuild-time dependency version (#2457)- Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10 (#2460)
Blackd
- Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that scan installed packages (#2440)
Integrations
- The provided pre-commit hooks no longer specify
language_versionto avoid overridingdefault_language_version(#2430)
Sourced from black's changelog.
21.9b0
Packaging
- Fix missing modules in self-contained binaries (#2466)
- Fix missing toml extra used during installation (#2475)
21.8b0
Black
- Add support for formatting Jupyter Notebook files (#2357)
- Move from
appdirsdependency toplatformdirs(#2375)- Present a more user-friendly error if .gitignore is invalid (#2414)
- The failsafe for accidentally added backslashes in f-string expressions has been hardened to handle more edge cases during quote normalization (#2437)
- Avoid changing a function return type annotation's type to a tuple by adding a trailing comma (#2384)
- Parsing support has been added for unparenthesized walruses in set literals, set comprehensions, and indices (#2447).
- Pin
setuptools-scmbuild-time dependency version (#2457)- Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10 (#2460)
Blackd
- Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that scan installed packages (#2440)
Integrations
- The provided pre-commit hooks no longer specify
language_versionto avoid overridingdefault_language_version(#2430)
Sourced from black's releases.
21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workersparameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatiblity (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
Sourced from black's changelog.
21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workersparameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatiblity (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
Sourced from black's releases.
21.11b0
Black
- Warn about Python 2 deprecation in more cases by improving Python 2 only syntax detection (#2592)
- Add experimental PyPy support (#2559)
- Add partial support for the match statement. As it's experimental, it's only enabled when
--target-version py310is explicitly specified (#2586)- Add support for parenthesized with (#2586)
- Declare support for Python 3.10 for running Black (#2562)
Integrations
- Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
- The vim plugin now parses
skip_magic_trailing_commafrom pyproject.toml (#2613)21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workersparameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatiblity (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
Sourced from black's changelog.
21.11b0
Black
- Warn about Python 2 deprecation in more cases by improving Python 2 only syntax detection (#2592)
- Add experimental PyPy support (#2559)
- Add partial support for the match statement. As it's experimental, it's only enabled when
--target-version py310is explicitly specified (#2586)- Add support for parenthesized with (#2586)
- Declare support for Python 3.10 for running Black (#2562)
Integrations
- Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
- The vim plugin now parses
skip_magic_trailing_commafrom pyproject.toml (#2613)21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workersparameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
Sourced from black's releases.
21.11b1
Black
- Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
21.11b0
Black
- Warn about Python 2 deprecation in more cases by improving Python 2 only syntax detection (#2592)
- Add experimental PyPy support (#2559)
- Add partial support for the match statement. As it's experimental, it's only enabled when
--target-version py310is explicitly specified (#2586)- Add support for parenthesized with (#2586)
- Declare support for Python 3.10 for running Black (#2562)
Integrations
- Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
- The vim plugin now parses
skip_magic_trailing_commafrom pyproject.toml (#2613)21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workersparameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatiblity (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
Sourced from black's changelog.
21.11b1
Black
- Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
21.11b0
Black
- Warn about Python 2 deprecation in more cases by improving Python 2 only syntax detection (#2592)
- Add experimental PyPy support (#2559)
- Add partial support for the match statement. As it's experimental, it's only enabled when
--target-version py310is explicitly specified (#2586)- Add support for parenthesized with (#2586)
- Declare support for Python 3.10 for running Black (#2562)
Integrations
- Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
- The vim plugin now parses
skip_magic_trailing_commafrom pyproject.toml (#2613)21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workersparameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
Sourced from black's releases.
22.3.0
Preview style
- Code cell separators
#%%are now standardised to# %%(#2919)- Remove unnecessary parentheses from
exceptstatements (#2939)- Remove unnecessary parentheses from tuple unpacking in
forloops (#2945)- Avoid magic-trailing-comma in single-element subscripts (#2942)
Configuration
- Do not format
__pypackages__directories by default (#2836)- Add support for specifying stable version with
--required-version(#2832).- Avoid crashing when the user has no homedir (#2814)
- Avoid crashing when md5 is not available (#2905)
- Fix handling of directory junctions on Windows (#2904)
Documentation
- Update pylint config documentation (#2931)
Integrations
- Move test to disable plugin in Vim/Neovim, which speeds up loading (#2896)
Output
- In verbose, mode, log when Black is using user-level config (#2861)
Packaging
- Fix Black to work with Click 8.1.0 (#2966)
- On Python 3.11 and newer, use the standard library's
tomllibinstead oftomli(#2903)black-primer, the deprecated internal devtool, has been removed and copied to a separate repository (#2924)Parser
- Black can now parse starred expressions in the target of
forandasync forstatements, e.gfor item in *items_1, *items_2: pass(#2879).
Sourced from black's changelog.
22.3.0
Preview style
- Code cell separators
#%%are now standardised to# %%(#2919)- Remove unnecessary parentheses from
exceptstatements (#2939)- Remove unnecessary parentheses from tuple unpacking in
forloops (#2945)- Avoid magic-trailing-comma in single-element subscripts (#2942)
Configuration
- Do not format
__pypackages__directories by default (#2836)- Add support for specifying stable version with
--required-version(#2832).- Avoid crashing when the user has no homedir (#2814)
- Avoid crashing when md5 is not available (#2905)
- Fix handling of directory junctions on Windows (#2904)
Documentation
- Update pylint config documentation (#2931)
Integrations
- Move test to disable plugin in Vim/Neovim, which speeds up loading (#2896)
Output
- In verbose, mode, log when Black is using user-level config (#2861)
Packaging
- Fix Black to work with Click 8.1.0 (#2966)
- On Python 3.11 and newer, use the standard library's
tomllibinstead oftomli(#2903)black-primer, the deprecated internal devtool, has been removed and copied to a separate repository (#2924)Parser
- Black can now parse starred expressions in the target of
forandasync forstatements, e.gfor item in *items_1, *items_2: pass(#2879).
ae2c075 Prepare release 22.3.0 (#2968)e9681a4 Fix _unicodefun patch code for Click 8.1.0 (#2966)ac7402c Bump sphinx from 4.4.0 to 4.5.0 in /docs (GH-2959)f239d22 Enforce no formatting changes for PRs via CI (GH-2951)bd1e980 Remove unnecessary parentheses from except clauses (#2939)14d84ba Resolve new flake8-bugbear errors (B020) (GH-2950)14e5ce5 Remove unnecessary parentheses from tuple unpacking in for loops (#2945)3800ebd Avoid magic-trailing-comma in single-element subscripts (#2942)062b549 Github now supports .git-blame-ignore-revs (GH-2948)5379d4f stub style: remove some possible future changes (#2940)Sourced from black's releases.
22.6.0
Style
- Fix unstable formatting involving
#fmt: skipand# fmt:skipcomments (notice the lack of spaces) (#2970)Preview style
- Docstring quotes are no longer moved if it would violate the line length limit (#3044)
- Parentheses around return annotations are now managed (#2990)
- Remove unnecessary parentheses around awaited objects (#2991)
- Remove unnecessary parentheses in
withstatements (#2926)- Remove trailing newlines after code block open (#3035)
Integrations
- Add
scripts/migrate-black.pyscript to ease introduction of Black to a Git project (#3038)Output
- Output Python version and implementation as part of
--versionflag (#2997)Packaging
- Use
tomliinstead oftomllibon Python 3.11 builds wheretomllibis not available (#2987)Parser
- PEP 654 syntax (for example,
except *ExceptionGroup:) is now supported (#3016)- PEP 646 syntax (for example,
Array[Batch, *Shape]ordef fn(*args: *T) -> None) is now supported (#3071)Vim Plugin
- Fix
strtoboolfunction. It didn't parse true/on/false/off. (#3025)Full Changelog: https://github.com/psf/black/compare/22.3.0...22.6.0
Thank you!
@jpy-gitfor improving our parentheses formatting significantly@siuryanfor fixing a fmt: skip bug, making it a little less annoying to use :)@isidenticalfor implementing support for PEP 654 and 646 syntax@defntvdmfor fixing our vim plugin, especially as we (the maintainers) don't really know vim script sadly@idorrington92for fixing the docstring bug where Black would move the closing quotes causing it to violate the line length limit (whoops!)@hbrunnfor contributing the migrate-black script@saroad2for improving newline handling after code blocks and test infrastructure improvements... and everyone else who contributed documentation, tests, or other improvements to the Black project!
... (truncated)
Sourced from black's changelog.
22.6.0
Style
- Fix unstable formatting involving
#fmt: skipand# fmt:skipcomments (notice the lack of spaces) (#2970)Preview style
- Docstring quotes are no longer moved if it would violate the line length limit (#3044)
- Parentheses around return annotations are now managed (#2990)
- Remove unnecessary parentheses around awaited objects (#2991)
- Remove unnecessary parentheses in
withstatements (#2926)- Remove trailing newlines after code block open (#3035)
Integrations
- Add
scripts/migrate-black.pyscript to ease introduction of Black to a Git project (#3038)Output
- Output Python version and implementation as part of
--versionflag (#2997)Packaging
- Use
tomliinstead oftomllibon Python 3.11 builds wheretomllibis not available (#2987)Parser
- PEP 654 syntax (for example,
except *ExceptionGroup:) is now supported (#3016)- PEP 646 syntax (for example,
Array[Batch, *Shape]ordef fn(*args: *T) -> None) is now supported (#3071)Vim Plugin
- Fix
strtoboolfunction. It didn't parse true/on/false/off. (#3025)22.3.0
Preview style
- Code cell separators
#%%are now standardised to# %%(#2919)- Remove unnecessary parentheses from
exceptstatements (#2939)- Remove unnecessary parentheses from tuple unpacking in
forloops (#2945)- Avoid magic-trailing-comma in single-element subscripts (#2942)
Configuration
... (truncated)
f6c139c Prepare docs for release 22.6.0 (#3139)eb5d175 Update preview style docs to include recent changes (#3136)d848209 Bump furo from 2022.6.4.1 to 2022.6.21 in /docs (#3138)fa6caa6 Only call get_future_imports when needed (#3135)6463fb8 Bump sphinx from 5.0.1 to 5.0.2 in /docs (#3128)e3c9b04 Replace link to Requests documentation (#3125)6c1bd08 Test run black on self (#3114)799adb5 Bump actions/setup-python from 3 to 4 (#3121)162ecd1 Use is_number_token instead of assertion (#3069)8c8675c Update documentation dependencies (#3118)Sourced from black's releases.
22.12.0
Preview style
- Enforce empty lines before classes and functions with sticky leading comments (#3302)
- 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)
- Implicitly concatenated strings used as function args are now wrapped inside parentheses (#3307)
- Correctly handle trailing commas that are inside a line's leading non-nested parens (#3370)
Configuration
- Fix incorrectly applied
.gitignorerules by considering the.gitignorelocation and the relative path to the target file (#3338)- Fix incorrectly ignoring
.gitignorepresence when more than one source directory is specified (#3336)Parser
- Parsing support has been added for walruses inside generator expression that are passed as function args (for example,
any(match := my_re.match(text) for text in texts)) (#3327).Integrations
- Vim plugin: Optionally allow using the system installation of Black via
let g:black_use_virtualenv = 0(#3309)
Sourced from black's changelog.
22.12.0
Preview style
- Enforce empty lines before classes and functions with sticky leading comments (#3302)
- 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)
- Implicitly concatenated strings used as function args are now wrapped inside parentheses (#3307)
- Correctly handle trailing commas that are inside a line's leading non-nested parens (#3370)
Configuration
- Fix incorrectly applied
.gitignorerules by considering the.gitignorelocation and the relative path to the target file (#3338)- Fix incorrectly ignoring
.gitignorepresence when more than one source directory is specified (#3336)Parser
- Parsing support has been added for walruses inside generator expression that are passed as function args (for example,
any(match := my_re.match(text) for text in texts)) (#3327).Integrations
- Vim plugin: Optionally allow using the system installation of Black via
let 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 black's releases.
23.1.0
Highlights
This 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.
There are also many changes to the preview style; try out
black --previewand 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
pyproject.tomlfile, removing the need to set Black's target versions separately.Stable style
- Introduce the 2023 stable style, which incorporates most aspects of last year's preview style (#3418). Specific changes:
- Enforce empty lines before classes and functions with sticky leading comments (#3302) (22.12.0)
- 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)
- Correctly handle trailing commas that are inside a line's leading non-nested parens (#3370) (22.12.0)
--skip-string-normalization/-Snow prevents docstring prefixes from being normalized as expected (#3168) (since 22.8.0)- When using
--skip-magic-trailing-commaor-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)
- Docstring quotes are no longer moved if it would violate the line length limit (#3044, #3430) (22.6.0)
- Parentheses around return annotations are now managed (#2990) (22.6.0)
- Remove unnecessary parentheses around awaited objects (#2991) (22.6.0)
- Remove unnecessary parentheses in
withstatements (#2926) (22.6.0)- Remove trailing newlines after code block open (#3035) (22.6.0)
- Code cell separators
#%%are now standardised to# %%(#2919) (22.3.0)- Remove unnecessary parentheses from
exceptstatements (#2939) (22.3.0)- Remove unnecessary parentheses from tuple unpacking in
forloops (#2945) (22.3.0)- Avoid magic-trailing-comma in single-element subscripts (#2942) (22.3.0)
- Fix a crash when a colon line is marked between
# fmt: offand# fmt: on(#3439)Preview style
- Format hex codes in unicode escape sequences in string literals (#2916)
- Add parentheses around
if-elseexpressions (#2278)- Improve performance on large expressions that contain many strings (#3467)
- Fix a crash in preview style with assert + parenthesized string (#3415)
- Fix crashes in preview style with walrus operators used in function return annotations and except clauses (#3423)
- Fix a crash in preview advanced string processing where mixed implicitly concatenated regular and f-strings start with an empty span (#3463)
- Fix a crash in preview advanced string processing where a standalone comment is placed before a dict's value (#3469)
- Fix an issue where extra empty lines are added when a decorator has
# fmt: skipapplied 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)
- 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)
- Fix two crashes in preview style involving edge cases with docstrings (#3451)
- Exclude string type annotations from improved string processing; fix crash when the return type annotation is stringified and spans across multiple lines (#3462)
- Wrap multiple context managers in parentheses when targeting Python 3.9+ (#3489)
- Fix several crashes in preview style with walrus operators used in
withstatements 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)
... (truncated)
Sourced from black's changelog.
23.1.0
Highlights
This is the first release of 2023, and following our stability policy, it comes with a number of improvements to our stable style, including improvements to empty line handling, removal of redundant parentheses in several contexts, and output that highlights implicitly concatenated strings better.
There are also many changes to the preview style; try out
black --previewand 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
pyproject.tomlfile, removing the need to set Black's target versions separately.Stable style
- Introduce the 2023 stable style, which incorporates most aspects of last year's preview style (#3418). Specific changes:
- Enforce empty lines before classes and functions with sticky leading comments (#3302) (22.12.0)
- 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)
- Implicitly concatenated strings used as function args are now wrapped inside parentheses (#3307) (22.12.0)
- Correctly handle trailing commas that are inside a line's leading non-nested parens (#3370) (22.12.0)
--skip-string-normalization/-Snow prevents docstring prefixes from being normalized as expected (#3168) (since 22.8.0)- When using
--skip-magic-trailing-commaor-C, trailing commas are stripped from subscript expressions with more than 1 element (#3209) (22.8.0)- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside parentheses (#3162) (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)
- Docstring quotes are no longer moved if it would violate the line length limit (#3044, #3430) (22.6.0)
- Parentheses around return annotations are now managed (#2990) (22.6.0)
- Remove unnecessary parentheses around awaited objects (#2991) (22.6.0)
- Remove unnecessary parentheses in
withstatements (#2926) (22.6.0)- Remove trailing newlines after code block open (#3035) (22.6.0)
- Code cell separators
#%%are now standardised to# %%(#2919) (22.3.0)- Remove unnecessary parentheses from
exceptstatements (#2939) (22.3.0)- Remove unnecessary parentheses from tuple unpacking in
forloops (#2945) (22.3.0)- Avoid magic-trailing-comma in single-element subscripts (#2942) (22.3.0)
... (truncated)
b0d1fba 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 black's releases.
23.3.0
Highlights
This release fixes a longstanding confusing behavior in Black's GitHub action, where the version of the action did not determine the version of Black being run (issue #3382). In addition, there is a small bug fix around imports and a number of improvements to the preview style.
Please try out the preview style with
black --previewand tell us your feedback. All changes in the preview style are expected to become part of Black's stable style in January 2024.Stable style
- Import lines with
# fmt: skipand# fmt: offno longer have an extra blank line added when they are right after another import line (#3610)Preview style
- Add trailing commas to collection literals even if there's a comment after the last entry (#3393)
async def,async for, andasync withstatements are now formatted consistently compared to their non-async version. (#3609)withstatements that contain two context managers will be consistently wrapped in parentheses (#3589)- Let string splitters respect East Asian Width (#3445)
- Now long string literals can be split after East Asian commas and periods (
、U+3001 IDEOGRAPHIC COMMA,。U+3002 IDEOGRAPHIC FULL STOP, &，U+FF0C FULLWIDTH COMMA) besides before spaces (#3445)- For stubs, enforce one blank line after a nested class with a body other than just
...(#3564)- Improve handling of multiline strings by changing line split behavior (#1879)
Parser
- Added support for formatting files with invalid type comments (#3594)
Integrations
- Update GitHub Action to use the version of Black equivalent to action's version if version input is not specified (#3543)
- Fix missing Python binary path in autoload script for vim (#3508)
Documentation
- Document that only the most recent release is supported for security issues; vulnerabilities should be reported through Tidelift (#3612)
... (truncated)
Sourced from black's changelog.
23.3.0
Highlights
This release fixes a longstanding confusing behavior in Black's GitHub action, where the version of the action did not determine the version of Black being run (issue #3382). In addition, there is a small bug fix around imports and a number of improvements to the preview style.
Please try out the preview style with
black --previewand tell us your feedback. All changes in the preview style are expected to become part of Black's stable style in January 2024.Stable style
- Import lines with
# fmt: skipand# fmt: offno longer have an extra blank line added when they are right after another import line (#3610)Preview style
- Add trailing commas to collection literals even if there's a comment after the last entry (#3393)
async def,async for, andasync withstatements are now formatted consistently compared to their non-async version. (#3609)withstatements that contain two context managers will be consistently wrapped in parentheses (#3589)- Let string splitters respect East Asian Width (#3445)
- Now long string literals can be split after East Asian commas and periods (
、U+3001 IDEOGRAPHIC COMMA,。U+3002 IDEOGRAPHIC FULL STOP, &，U+FF0C FULLWIDTH COMMA) besides before spaces (#3445)- For stubs, enforce one blank line after a nested class with a body other than just
...(#3564)- Improve handling of multiline strings by changing line split behavior (#1879)
Parser
- Added support for formatting files with invalid type comments (#3594)
Integrations
- Update GitHub Action to use the version of Black equivalent to action's version if version input is not specified (#3543)
- Fix missing Python binary path in autoload script for vim (#3508)
Documentation
- Document that only the most recent release is supported for security issues; vulnerabilities should be reported through Tidelift (#3612)
... (truncated)
bf7a162 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 black's releases.
22.8.0
Highlights
- Python 3.11 is now supported, except for blackd as aiohttp does not support 3.11 as of publishing (#3234)
- This is the last release that supports running Black on Python 3.6 (formatting 3.6 code will continue to be supported until further notice)
- Reword the stability policy to say that we may, in rare cases, make changes that affect code that was not previously formatted by Black (#3155)
Stable style
- Fix an infinite loop when using
# fmt: on/offin the middle of an expression or code block (#3158)- Fix incorrect handling of
# fmt: skipon colon (:) lines (#3148)- Comments are no longer deleted when a line had spaces removed around power operators (#2874)
Preview style
- Single-character closing docstring quotes are no longer moved to their own line as this is invalid. This was a bug introduced in version 22.6.0. (#3166)
--skip-string-normalization/-Snow prevents docstring prefixes from being normalized as expected (#3168)- When using
--skip-magic-trailing-commaor-C, trailing commas are stripped from subscript expressions with more than 1 element (#3209)- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside parentheses (#3162)
- Fix a string merging/split issue when a comment is present in the middle of implicitly concatenated strings on its own line (#3227)
Blackd
blackdnow supports enabling the preview style via theX-Previewheader (#3217)Configuration
- Black now uses the presence of debug f-strings to detect target version (#3215)
- Fix misdetection of project root and verbose logging of sources in cases involving
--stdin-filename(#3216)- Immediate
.gitignorefiles in source directories given on the command line are now also respected, previously only.gitignorefiles in the project root and automatically discovered directories were respected (#3237)Documentation
- Recommend using BlackConnect in IntelliJ IDEs (#3150)
Integrations
- Vim plugin: prefix messages with
Black:so it's clear they come from Black (#3194)- Docker: changed to a /opt/venv installation + added to PATH to be available to non-root users (#3202)
Output
- Change from deprecated
asyncio.get_event_loop()to create our event loop which removes DeprecationWarning (#3164)- Remove logging from internal
blib2to3library since it regularly emits error logs about failed caching that can and should be ignored (#3193)Parser
- Type comments are now included in the AST equivalence check consistently so accidental deletion raises an error. Though type comments can't be tracked when running on PyPy 3.7 due to standard library limitations. (#2874)
Performance
... (truncated)
Sourced from black's changelog.
22.8.0
Highlights
- Python 3.11 is now supported, except for blackd as aiohttp does not support 3.11 as of publishing (#3234)
- This is the last release that supports running Black on Python 3.6 (formatting 3.6 code will continue to be supported until further notice)
- Reword the stability policy to say that we may, in rare cases, make changes that affect code that was not previously formatted by Black (#3155)
Stable style
- Fix an infinite loop when using
# fmt: on/offin the middle of an expression or code block (#3158)- Fix incorrect handling of
# fmt: skipon colon (:) lines (#3148)- Comments are no longer deleted when a line had spaces removed around power operators (#2874)
Preview style
- Single-character closing docstring quotes are no longer moved to their own line as this is invalid. This was a bug introduced in version 22.6.0. (#3166)
--skip-string-normalization/-Snow prevents docstring prefixes from being normalized as expected (#3168)- When using
--skip-magic-trailing-commaor-C, trailing commas are stripped from subscript expressions with more than 1 element (#3209)- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside parentheses (#3162)
- Fix a string merging/split issue when a comment is present in the middle of implicitly concatenated strings on its own line (#3227)
Blackd
blackdnow supports enabling the preview style via theX-Previewheader (#3217)Configuration
- Black now uses the presence of debug f-strings to detect target version (#3215)
- Fix misdetection of project root and verbose logging of sources in cases involving
--stdin-filename(#3216)- Immediate
.gitignorefiles in source directories given on the command line are now also respected, previously only.gitignorefiles in the project root and automatically discovered directories were respected (#3237)Documentation
- Recommend using BlackConnect in IntelliJ IDEs (#3150)
Integrations
... (truncated)
2018e66 Prepare docs for release 22.8.0 (#3248)0019261 Update stable branch after publishing to PyPI (#3223)7757078 Improve & update release process to reflect recent changes (#3242)767604e Use .gitignore files in the initial source directories (#3237)2c90480 Use strict mypy checking (#3222)ba618a3 Add parens around implicit string concatenations where it increases readabili...c0cc19b Delay worker count determinationafed2c0 Load .gitignore and exclude regex at time of usee269f44 Lazily import parallelized format modulesc47b91f Fix misdetection of project root with --stdin-filename (#3216)Sourced from black's releases.
22.10.0
Highlights
- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be supported until further notice.
Stable style
- Fix a crash when
# fmt: onis used on a different block level than# fmt: off(#3281)Preview style
- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys (#3262)
Configuration
.ipynb_checkpointsdirectories are now excluded by default (#3293)- Add
--skip-source-first-line/-xoption to ignore the first line of source code while formatting (#3299)Packaging
- Executables made with PyInstaller will no longer crash when formatting several files at once on macOS. Native x86-64 executables for macOS are available once again. (#3275)
- Hatchling is now used as the build backend. This will not have any effect for users who install Black with its wheels from PyPI. (#3233)
- Faster compiled wheels are now available for CPython 3.11 (#3276)
Blackd
- Windows style (CRLF) newlines will be preserved (#3257).
Integrations
Sourced from black's changelog.
22.10.0
Highlights
- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be supported until further notice.
Stable style
- Fix a crash when
# fmt: onis used on a different block level than# fmt: off(#3281)Preview style
- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys (#3262)
Configuration
.ipynb_checkpointsdirectories are now excluded by default (#3293)- Add
--skip-source-first-line/-xoption to ignore the first line of source code while formatting (#3299)Packaging
- Executables made with PyInstaller will no longer crash when formatting several files at once on macOS. Native x86-64 executables for macOS are available once again. (#3275)
- Hatchling is now used as the build backend. This will not have any effect for users who install Black with its wheels from PyPI. (#3233)
- Faster compiled wheels are now available for CPython 3.11 (#3276)
Blackd
- Windows style (CRLF) newlines will be preserved (#3257).
Integrations
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 black's releases.
23.7.0
Highlights
- Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be supported until further notice (#3765)
Stable style
- Fix a bug where an illegal trailing comma was added to return type annotations using PEP 604 unions (#3735)
- Fix several bugs and crashes where comments in stub files were removed or mishandled under some circumstances (#3745)
- Fix a crash with multi-line magic comments like
type: ignorewithin parentheses (#3740)- Fix error in AST validation when Black removes trailing whitespace in a type comment (#3773)
Preview style
- Implicitly concatenated strings used as function args are no longer wrapped inside parentheses (#3640)
- Remove blank lines between a class definition and its docstring (#3692)
Configuration
- The
--workersargument to Black can now be specified via theBLACK_NUM_WORKERSenvironment variable (#3743).pytest_cache,.ruff_cacheand.vscodeare now excluded by default (#3691)- Fix Black not honouring
pyproject.tomlsettings when running--stdin-filenameand thepyproject.tomlfound isn't in the current working directory (#3719)- Black will now error if
excludeandextend-excludehave invalid data types inpyproject.toml, instead of silently doing the wrong thing (#3764)Packaging
- Upgrade mypyc from 0.991 to 1.3 (#3697)
- Remove patching of Click that mitigated errors on Python 3.6 with
LANG=C(#3768)Parser
- Add support for the new PEP 695 syntax in Python 3.12 (#3703)
Performance
- Speed up Black significantly when the cache is full (#3751)
- Avoid importing
IPythonin a case where we wouldn't need it (#3748)Output
... (truncated)
Sourced from black's changelog.
23.7.0
Highlights
- Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be supported until further notice (#3765)
Stable style
- Fix a bug where an illegal trailing comma was added to return type annotations using PEP 604 unions (#3735)
- Fix several bugs and crashes where comments in stub files were removed or mishandled under some circumstances (#3745)
- Fix a crash with multi-line magic comments like
type: ignorewithin parentheses (#3740)- Fix error in AST validation when Black removes trailing whitespace in a type comment (#3773)
Preview style
- Implicitly concatenated strings used as function args are no longer wrapped inside parentheses (#3640)
- Remove blank lines between a class definition and its docstring (#3692)
Configuration
- The
--workersargument to Black can now be specified via theBLACK_NUM_WORKERSenvironment variable (#3743).pytest_cache,.ruff_cacheand.vscodeare now excluded by default (#3691)- Fix Black not honouring
pyproject.tomlsettings when running--stdin-filenameand thepyproject.tomlfound isn't in the current working directory (#3719)- Black will now error if
excludeandextend-excludehave invalid data types inpyproject.toml, instead of silently doing the wrong thing (#3764)Packaging
- Upgrade mypyc from 0.991 to 1.3 (#3697)
- Remove patching of Click that mitigated errors on Python 3.6 with
LANG=C(#3768)Parser
- Add support for the new PEP 695 syntax in Python 3.12 (#3703)
Performance
- Speed up Black significantly when the cache is full (#3751)
- Avoid importing
IPythonin a case where we wouldn't need it (#3748)Output
... (truncated)
193ee76 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.
1.13.0 (2023-01-16)
Note Adam Johnson is new maintainer.
Require Black 22.1.0+.
Add
--rst-literal-blocksoption, to also format text in reStructuredText literal blocks, starting with::. Sphinx highlights these with the project’s 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)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)2e74dc4 Version 1.15.08ddb2f1 [pre-commit.ci] pre-commit autoupdate (#257)64fbca6 Drop Python 3.7 support (#256)f6a0817 [pre-commit.ci] pre-commit autoupdate (#255)cbdcb50 [pre-commit.ci] pre-commit autoupdate (#254)37fc70e Upgrade requirements (#253)7bbe434 [pre-commit.ci] pre-commit autoupdate (#250)Sourced from sphinx's releases.
Sphinx 7.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.2 (released Aug 02, 2023)
Bugs fixed
- #11542: linkcheck: Properly respect :confval:
linkcheck_anchorsand do not spuriously report failures to validate anchors. Patch by James Addison.Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
- #11514: Fix
SOURCE_DATE_EPOCHin multi-line copyright footer. Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module,keyword,operator,object,exception,statement, andbuiltin) in the :rst:dir:indexdirective, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinxnow allows the version requirement to be specified as(major, minor).- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_lengthand the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list.
... (truncated)
320d0b6 Bump to 7.1.2 final06c1339 Ensure that linkcheck_anchors is properly respected (#11544)89808c6 Emend attribution for GH-11431 in CHANGES (#11547)4958d2a Fix flake8 E231 reported linting failure4862da8 Bump versiond8d73c1 Bump to 7.1.1 finala54e630 [internationalisation] Update message catalogues8452300 Fix multi-line copyright when SOURCE_DATE_EPOCH is set (#11524)fe08cec bump versione560f63 Bump to 7.1.0 finalSourced from furo's changelog.
Changelog
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
... (truncated)
35f5307 Prepare release: 2023.07.260a8bedc Update changeloga92dd0c Make _add_asset_hashes a no-op with Sphinx 7.1f8db95b Improve literals with inline code are handled1680dbe Document the use of figclass with figure directivebeebd7e Increase the specificity of the admonition title selector834e951 Setup uploads to Percy27bf2c0 [pre-commit.ci] pre-commit autoupdate (#672)c8b51d0 Fix how content overflow is handled80afa27 [pre-commit.ci] pre-commit autoupdate (#652)2e74dc4 Version 1.15.08ddb2f1 [pre-commit.ci] pre-commit autoupdate (#257)64fbca6 Drop Python 3.7 support (#256)f6a0817 [pre-commit.ci] pre-commit autoupdate (#255)cbdcb50 [pre-commit.ci] pre-commit autoupdate (#254)37fc70e Upgrade requirements (#253)7bbe434 [pre-commit.ci] pre-commit autoupdate (#250)Sourced from furo's changelog.
Changelog
2023.03.23 -- Sassy Saffron
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
- Replace the
metagenerator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
- Add support for aligning text in MyST-parser generated tables.
2022.09.15 -- Pragmatic Pistachio
- Add a minimum version constraint on pygments.
- Add an explicit dependency on
sass.- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
- Correctly select only Furo's own
svgin related pagesnav.- Make numpy-style documentation headers consistent.
- Retitle the reference section.
- Update npm dependencies.
... (truncated)
81139dd 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 furo's changelog.
Changelog
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
- Replace the
metagenerator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
- Add support for aligning text in MyST-parser generated tables.
2022.09.15 -- Pragmatic Pistachio
- Add a minimum version constraint on pygments.
- Add an explicit dependency on
sass.- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
... (truncated)
2f61e10 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.
Changelog
2022.06.21 -- Opulent Opal
- Fix
docutils <= 0.17.xcompatibility- Bump to the latest Node.js LTS
2022.06.04.1 -- Naughty Nickel bugfix
- Fix the URL used in the "Edit this page" for Read the Docs builds.
2022.06.04 -- Naughty Nickel
- ✨ Advertise Sphinx 5 compatibility.
- ✨ Change to
basic-ngas the base theme (from {pypi}sphinx-basic-ng).- Document site-wide announcement banners.
- Drop the pin on pygments.
- Improve edit button, using
basic-ng'sedit-this-pagecomponent.- Tweak headings to better match what users expect.
- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.
2022.04.07 -- Magical Mauve
- ✨ Make sphinx-copybutton look better.
- Add margin to indentations in line blocks.
- Add styling for non-arabic list styles
- Add support for
html_baseurl.- Improve "Edit this page" icon to be more accessible.
- Improve
html_sidebarsexample.- Tweak positioning of back to top on desktop.
2022.03.04 -- Lucent Lilac
- Improve support for print media.
- Reduce heading sizes for h3 and below.
- Don't allow selecting headerlink content.
- Improve how overflow wrapping is handled.
- Add a reference from the configuration variables to the color customisation page.
2022.02.23 -- Keen Kobi
... (truncated)
a2e8f42 Prepare release: 2022.06.21d4967e5 Update changelog2969c23 [pre-commit.ci] pre-commit autoupdate (#455)2365493 Use findall from docutils only if it's availablebb3c355 Merge pull request #450 from polyzen/patch-14fb1a74 Bump to the latest Node.js LTS9970aac Back to development1142fad Prepare release: 2022.06.04.1211abb4 Update changelog06cdba6 Fix the edit this page URLSourced from furo's changelog.
Changelog
2022.06.04.1 -- Naughty Nickel bugfix
- Fix the URL used in the "Edit this page" for Read the Docs builds.
2022.06.04 -- Naughty Nickel
- ✨ Advertise Sphinx 5 compatibility.
- ✨ Change to
basic-ngas the base theme (from {pypi}sphinx-basic-ng).- Document site-wide announcement banners.
- Drop the pin on pygments.
- Improve edit button, using
basic-ng'sedit-this-pagecomponent.- Tweak headings to better match what users expect.
- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.
2022.04.07 -- Magical Mauve
- ✨ Make sphinx-copybutton look better.
- Add margin to indentations in line blocks.
- Add styling for non-arabic list styles
- Add support for
html_baseurl.- Improve "Edit this page" icon to be more accessible.
- Improve
html_sidebarsexample.- Tweak positioning of back to top on desktop.
2022.03.04 -- Lucent Lilac
- Improve support for print media.
- Reduce heading sizes for h3 and below.
- Don't allow selecting headerlink content.
- Improve how overflow wrapping is handled.
- Add a reference from the configuration variables to the color customisation page.
2022.02.23 -- Keen Kobi
- ✨ Add a "Back to Top" button that shows up when scrolling up.
- Add a URL to GitHub in Project-URLs.
- Break long words in the prev/next buttons.
- Fix includes in Kitchen sink.
... (truncated)
1142fad Prepare release: 2022.06.04.1211abb4 Update changelog06cdba6 Fix the edit this page URL43ce491 Back to developmentfb6e486 Prepare release: 2022.06.04090b02e Update changelog098d51d Fix the Just the Docs link7fa8d08 Change to a post-transform for wrapping math blocks and table51f1e52 Speed up determining if there's multiple toc entries99a6ff8 Update caniuse-lite NPM packageSourced from furo's changelog.
Changelog
2022.09.15 -- Pragmatic Pistachio
- Add a minimum version constraint on pygments.
- Add an explicit dependency on
sass.- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
- Correctly select only Furo's own
svgin related pagesnav.- Make numpy-style documentation headers consistent.
- Retitle the reference section.
- Update npm dependencies.
2022.06.21 -- Opulent Opal
- Fix
docutils <= 0.17.xcompatibility.- Bump to the latest Node.js LTS.
2022.06.04.1 -- Naughty Nickel bugfix
- Fix the URL used in the "Edit this page" for Read the Docs builds.
2022.06.04 -- Naughty Nickel
- ✨ Advertise Sphinx 5 compatibility.
- ✨ Change to
basic-ngas the base theme (from {pypi}sphinx-basic-ng).- Document site-wide announcement banners.
- Drop the pin on pygments.
- Improve edit button, using
basic-ng'sedit-this-pagecomponent.- Tweak headings to better match what users expect.
- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.
2022.04.07 -- Magical Mauve
- ✨ Make sphinx-copybutton look better.
- Add margin to indentations in line blocks.
- Add styling for non-arabic list styles
- Add support for
html_baseurl.
... (truncated)
08e6b38 Prepare release: 2022.09.159de7613 Update changeloga064929 Tweak changelog content style46f4adc Revert "Add initial theme.conf content for eventual ablog support"45b839b Set a minimum constraint on pygmentsa4af988 [pre-commit.ci] pre-commit autoupdate (#518)a72186f [pre-commit.ci] pre-commit autoupdate (#504)9f41ee6 Add initial theme.conf content for eventual ablog support75e0361 Make numpy-style documentation headers consistent9d280e6 [pre-commit.ci] pre-commit autoupdate (#487)Sourced from furo's changelog.
Changelog
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
- Add support for aligning text in MyST-parser generated tables.
2022.09.15 -- Pragmatic Pistachio
- Add a minimum version constraint on pygments.
- Add an explicit dependency on
sass.- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
- Correctly select only Furo's own
svgin related pagesnav.- Make numpy-style documentation headers consistent.
- Retitle the reference section.
- Update npm dependencies.
2022.06.21 -- Opulent Opal
- Fix
docutils <= 0.17.xcompatibility.- Bump to the latest Node.js LTS.
2022.06.04.1 -- Naughty Nickel bugfix
- Fix the URL used in the "Edit this page" for Read the Docs builds.
2022.06.04 -- Naughty Nickel
- ✨ Advertise Sphinx 5 compatibility.
- ✨ Change to
basic-ngas the base theme (from {pypi}sphinx-basic-ng).- Document site-wide announcement banners.
- Drop the pin on pygments.
- Improve edit button, using
basic-ng'sedit-this-pagecomponent.- Tweak headings to better match what users expect.
- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.
2022.04.07 -- Magical Mauve
... (truncated)
1375f9d 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 developmentSourced from furo's changelog.
Changelog
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
- Replace the
metagenerator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
- Add support for aligning text in MyST-parser generated tables.
2022.09.15 -- Pragmatic Pistachio
- Add a minimum version constraint on pygments.
- Add an explicit dependency on
sass.- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
- Correctly select only Furo's own
svgin related pagesnav.- Make numpy-style documentation headers consistent.
- Retitle the reference section.
- Update npm dependencies.
2022.06.21 -- Opulent Opal
- Fix
docutils <= 0.17.xcompatibility.- Bump to the latest Node.js LTS.
2022.06.04.1 -- Naughty Nickel bugfix
- Fix the URL used in the "Edit this page" for Read the Docs builds.
2022.06.04 -- Naughty Nickel
... (truncated)
1034267 Prepare release: 2022.12.07239e69f Update changelog8faac34 Remove the no-longer-useful gh-pages workflowfaa27fb Fix the hyperlink warning9849ec0 Forward the arguments to stb servee0dc9b8 [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 furo's changelog.
Changelog
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
- Replace the
metagenerator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
... (truncated)
d2c9ca8 Prepare release: 2023.05.20662d21b Update changelog591780b Bump compatible Sphinx versionc2e7837 Bump NodeJS and package versionsdd85574 Use the reference HtmlFormatter class defined on PygmentsBridge. (#657)6bff419 Fix broken link (#654)e7f732e Improve the screen-reader label for sidebar collapse48c0bf2 Drop the check for the theme name1b17d81 [pre-commit.ci] pre-commit autoupdate (#646)4904fd5 Remove Python 3.8 constraint from Black pre-commit config (#647)Sourced from furo's changelog.
Changelog
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
... (truncated)
35f5307 Prepare release: 2023.07.260a8bedc Update changeloga92dd0c Make _add_asset_hashes a no-op with Sphinx 7.1f8db95b Improve literals with inline code are handled1680dbe Document the use of figclass with figure directivebeebd7e Increase the specificity of the admonition title selector834e951 Setup uploads to Percy27bf2c0 [pre-commit.ci] pre-commit autoupdate (#672)c8b51d0 Fix how content overflow is handled80afa27 [pre-commit.ci] pre-commit autoupdate (#652)Sourced from sphinx's releases.
v6.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.0.0 (released Dec 29, 2022)
Dependencies
- #10468: Drop Python 3.6 support
- #10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner
Incompatible changes
#7405: Removed the jQuery and underscore.js JavaScript frameworks.
These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the
jQuery,$, or$uglobal objects, you need to update your JavaScript to modern standards, or use the mitigation below.The first option is to use the sphinxcontrib.jquery_ extension, which has been developed by the Sphinx team and contributors. To use this, add
sphinxcontrib.jqueryto theextensionslist inconf.py, or callapp.setup_extension("sphinxcontrib.jquery")if you develop a Sphinx theme or extension.The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy
jquery.jsandunderscore.jsfromthe Sphinx repository_ to yourstaticdirectory, and add the following to yourlayout.html:.. code-block:: html+jinja
{%- block scripts %} {{ super() }} {%- endblock %}
.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/
Patch by Adam Turner.
#10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:
dev-deprecated-apisfor details. Patch by Adam Turner.#10901: C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables
c_allow_pre_v3andc_warn_on_allowed_pre_v3. Patch by Adam Turner.Features added
... (truncated)
5b56a23 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 sphinx's releases.
v6.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.1.0 (released Jan 05, 2023)
Dependencies
Adopted the
Ruff_ code linter... _Ruff: https://github.com/charliermarsh/ruff
Incompatible changes
- #10979: gettext: Removed support for pluralisation in
get_translation. This was unused and complicated other changes tosphinx.locale.Deprecated
sphinx.utilfunctions:
- Renamed
sphinx.util.typing.stringify()tosphinx.util.typing.stringify_annotation()- Moved
sphinx.util.xmlname_checker()tosphinx.builders.epub3._XML_NAME_PATTERNMoved to
sphinx.util.display:
sphinx.util.status_iteratorsphinx.util.display_chunksphinx.util.SkipProgressMessagesphinx.util.progress_messageMoved to
sphinx.util.http_date:
sphinx.util.epoch_to_rfc1123sphinx.util.rfc1123_to_epochMoved to
sphinx.util.exceptions:
sphinx.util.save_tracebacksphinx.util.format_exception_cut_framesFeatures added
- Cache doctrees in the build environment during the writing phase.
- Make all writing phase tasks support parallel execution.
- #11072: Use PEP 604 (
X | Y) display conventions fortyping.Optionalandtyping.Optionaltypes within the Python domain and autodoc.
... (truncated)
4e1004a 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.
v6.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.1.1 (released Jan 05, 2023)
Bugs fixed
- #11091: Fix
util.nodes.apply_source_workaroundforliteral_blocknodes with no source information in the node or the node's parents.Release 6.1.0 (released Jan 05, 2023)
Dependencies
Adopted the
Ruff_ code linter... _Ruff: https://github.com/charliermarsh/ruff
Incompatible changes
- #10979: gettext: Removed support for pluralisation in
get_translation. This was unused and complicated other changes tosphinx.locale.Deprecated
sphinx.utilfunctions:
- Renamed
sphinx.util.typing.stringify()tosphinx.util.typing.stringify_annotation()- Moved
sphinx.util.xmlname_checker()tosphinx.builders.epub3._XML_NAME_PATTERNMoved to
sphinx.util.display:
sphinx.util.status_iteratorsphinx.util.display_chunksphinx.util.SkipProgressMessagesphinx.util.progress_messageMoved to
sphinx.util.http_date:
sphinx.util.epoch_to_rfc1123sphinx.util.rfc1123_to_epochMoved to
sphinx.util.exceptions:
sphinx.util.save_traceback
... (truncated)
77aaa86 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.
v6.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.1.2 (released Jan 07, 2023)
Bugs fixed
#11101: LaTeX:
div.topic_paddingkey of sphinxsetup documented at 5.1.0 was implemented with nametopic_padding#11099: LaTeX:
shadowrulekey of sphinxsetup causes PDF build to crash since Sphinx 5.1.0#11096: LaTeX:
shadowsizekey of sphinxsetup causes PDF build to crash since Sphinx 5.1.0#11095: LaTeX: shadow of :dudir:
topicand contents_ boxes not in page margin since Sphinx 5.1.0.. _contents: https://docutils.sourceforge.io/docs/ref/rst/directives.html#table-of-contents
#11100: Fix copying images when running under parallel mode.
Release 6.1.1 (released Jan 05, 2023)
Bugs fixed
- #11091: Fix
util.nodes.apply_source_workaroundforliteral_blocknodes with no source information in the node or the node's parents.Release 6.1.0 (released Jan 05, 2023)
Dependencies
Adopted the
Ruff_ code linter... _Ruff: https://github.com/charliermarsh/ruff
Incompatible changes
- #10979: gettext: Removed support for pluralisation in
get_translation. This was unused and complicated other changes tosphinx.locale.Deprecated
sphinx.utilfunctions:
- Renamed
sphinx.util.typing.stringify()tosphinx.util.typing.stringify_annotation()
... (truncated)
393b408 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.
v6.1.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
776d01e Bump to 6.1.3 finala2e922a CHANGES for Sphinx 6.1.331162a9 Handle exceptions for get_node_source and get_node_linedcb4429 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.
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.2.0 (released Apr 23, 2023)
Dependencies
- Require Docutils 0.18.1 or greater.
Incompatible changes
- LaTeX: removal of some internal TeX
\dimenregisters (not previously publicly documented) as per 5.1.0 code comments insphinx.sty:\sphinxverbatimsep,\sphinxverbatimborder,\sphinxshadowsep,\sphinxshadowsize, and\sphinxshadowrule. (refs: #11105)- Remove
.eggsupport from pycodeModuleAnalyser; Python eggs are a now-obsolete binary distribution format- #11089: Remove deprecated code in
sphinx.builders.linkcheck. Patch by Daniel Eades- Remove internal-only
sphinx.locale.setlocaleDeprecated
- #11247: Deprecate the legacy
intersphinx_mappingformatsphinx.util.osutil.cdis deprecated in favour ofcontextlib.chdir.Features added
- #11277: :rst:dir:
autopropertyallows the return type to be specified as a type comment (e.g.,# type: () -> int). Patch by Bénédikt Tran- #10811: Autosummary: extend
__all__to imported members for template rendering when optionautosummary_ignore_module_allis set toFalse. Patch by Clement Pinard- #11147: Add a
content_offsetparameter tonested_parse_with_titles(), allowing for correct line numbers during nested parsing. Patch by Jeremy Maitin-Shepard- Update to Unicode CLDR 42
- Add a
--jobssynonym for-j. Patch by Hugo van Kemenade- LaTeX: a command
\sphinxboxfor styling text elements with a (possibly rounded) box, optional background color and shadow, has been added. See :ref:sphinxbox. (refs: #11224)- LaTeX: add
\sphinxstylenotetitle, ...,\sphinxstylewarningtitle, ..., for an extra layer of mark-up freeing up\sphinxstrongfor other uses. See :ref:latex-macros. (refs: #11267)- LaTeX: :dudir:
note, :dudir:hint, :dudir:importantand :dudir:tipcan now each be styled as the other admonitions, i.e. possibly with a background color, individual border widths and paddings, possibly rounded corners, and optional shadow. See :ref:additionalcss. (refs: #11234)
... (truncated)
e7d4c36 Bump to 6.2.0 final4e27a5f Remove unneeded JavaScript from sphinx13 themebffb547 Note correct deprecation version for sphinx.util.osutil.cd59de8d5 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 sphinx's releases.
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.2.1 (released Apr 25, 2023)
Bugs fixed
- #11355: Revert the default type of :confval:
nitpick_ignoreand :confval:nitpick_ignore_regextolist.Release 6.2.0 (released Apr 23, 2023)
Dependencies
- Require Docutils 0.18.1 or greater.
Incompatible changes
- LaTeX: removal of some internal TeX
\dimenregisters (not previously publicly documented) as per 5.1.0 code comments insphinx.sty:\sphinxverbatimsep,\sphinxverbatimborder,\sphinxshadowsep,\sphinxshadowsize, and\sphinxshadowrule. (refs: #11105)- Remove
.eggsupport from pycodeModuleAnalyser; Python eggs are a now-obsolete binary distribution format- #11089: Remove deprecated code in
sphinx.builders.linkcheck. Patch by Daniel Eades- Remove internal-only
sphinx.locale.setlocaleDeprecated
- #11247: Deprecate the legacy
intersphinx_mappingformatsphinx.util.osutil.cdis deprecated in favour ofcontextlib.chdir.Features added
- #11277: :rst:dir:
autopropertyallows the return type to be specified as a type comment (e.g.,# type: () -> int). Patch by Bénédikt Tran- #10811: Autosummary: extend
__all__to imported members for template rendering when optionautosummary_ignore_module_allis set toFalse. Patch by Clement Pinard- #11147: Add a
content_offsetparameter tonested_parse_with_titles(), allowing for correct line numbers during nested parsing. Patch by Jeremy Maitin-Shepard- Update to Unicode CLDR 42
- Add a
--jobssynonym for-j. Patch by Hugo van Kemenade- LaTeX: a command
\sphinxboxfor styling text elements with a (possibly
... (truncated)
ec993dd Bump to 6.2.1 finald2aa91f Revert the default type of nitpick_ignore[_regex] to list60d8fa1 Bump version70102ac Bump to 6.2.0 final4e27a5f Remove unneeded JavaScript from sphinx13 themebffb547 Note correct deprecation version for sphinx.util.osutil.cd59de8d5 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.
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.0.0 (released Apr 29, 2023)
Incompatible changes
- #11359: Remove long-deprecated aliases for
MecabSplitterandDefaultSplitterinsphinx.search.ja.- #11360: Remove deprecated
make_old_idfunctions in domain object description classes.- #11363: Remove the Setuptools integration (
build_sphinxhook insetup.py).- #11364: Remove deprecated
sphinx.ext.napoleon.iteratorsmodule.- #11365: Remove support for the
jsdumpformat insphinx.search.- #11366: Make
localea required argument tosphinx.util.i18n.format_date().- #11370: Remove deprecated
sphinx.util.stemmermodule.- #11371: Remove deprecated
sphinx.pycode.ast.parse()function.- #11372: Remove deprecated
sphinx.io.read_doc()function.- #11373: Removed deprecated
sphinx.util.get_matching_files()function.- #11378: Remove deprecated
sphinx.util.docutils.is_html5_writer_available()function.- #11379: Make the
envargument toBuildersubclasses required.- #11380: autosummary: Always emit grouped import exceptions.
- #11381: Remove deprecated
stylekey for HTML templates.- #11382: Remove deprecated
sphinx.writers.latex.LaTeXTranslator.docclassesattribute.- #11383: Remove deprecated
sphinx.builders.html.html5_readyandsphinx.builders.html.HTMLTranslatorattributes.- #11385: Remove support for HTML 4 output.
Release 6.2.1 (released Apr 25, 2023)
Bugs fixed
- #11355: Revert the default type of :confval:
nitpick_ignoreand :confval:nitpick_ignore_regextolist.Release 6.2.0 (released Apr 23, 2023)
Dependencies
- Require Docutils 0.18.1 or greater.
Incompatible changes
... (truncated)
d568b2f 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.
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.0.1 (released May 12, 2023)
Dependencies
- #11411: Support
Docutils 0.20_. Patch by Adam Turner... _Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04
Bugs fixed
- #11418: Clean up remaining references to
sphinx.setup_commandfollowing the removal of support for setuptools. Patch by Willem Mulder.Release 7.0.0 (released Apr 29, 2023)
Incompatible changes
- #11359: Remove long-deprecated aliases for
MecabSplitterandDefaultSplitterinsphinx.search.ja.- #11360: Remove deprecated
make_old_idfunctions in domain object description classes.- #11363: Remove the Setuptools integration (
build_sphinxhook insetup.py).- #11364: Remove deprecated
sphinx.ext.napoleon.iteratorsmodule.- #11365: Remove support for the
jsdumpformat insphinx.search.- #11366: Make
localea required argument tosphinx.util.i18n.format_date().- #11370: Remove deprecated
sphinx.util.stemmermodule.- #11371: Remove deprecated
sphinx.pycode.ast.parse()function.- #11372: Remove deprecated
sphinx.io.read_doc()function.- #11373: Removed deprecated
sphinx.util.get_matching_files()function.- #11378: Remove deprecated
sphinx.util.docutils.is_html5_writer_available()function.- #11379: Make the
envargument toBuildersubclasses required.- #11380: autosummary: Always emit grouped import exceptions.
- #11381: Remove deprecated
stylekey for HTML templates.- #11382: Remove deprecated
sphinx.writers.latex.LaTeXTranslator.docclassesattribute.- #11383: Remove deprecated
sphinx.builders.html.html5_readyandsphinx.builders.html.HTMLTranslatorattributes.- #11385: Remove support for HTML 4 output.
Release 6.2.1 (released Apr 25, 2023)
... (truncated)
d48cc78 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.
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module,keyword,operator,object,exception,statement, andbuiltin) in the :rst:dir:indexdirective, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinxnow allows the version requirement to be specified as(major, minor).- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_lengthand the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list. Patch by Thomas Louf, Adam Turner, and Jean-François B.- #10983: Support for multiline copyright statements in the footer block. Patch by Stefanie Molin
sphinx.util.display.status_iteratornow clears the current line with ANSI control codes, rather than overprinting with space characters.- #11431: linkcheck: Treat SSL failures as broken links. Patch by Bénédikt Tran
- #11157: Keep the
translatedattribute on translated nodes.- #11451: Improve the traceback displayed when using :option:
sphinx-build -Tin parallel builds. Patch by Bénédikt Tran- #11324: linkcheck: Use session-basd HTTP requests.
- #11438: Add support for the :rst:dir:
py:classand :rst:dir:py:functiondirectives for PEP 695 (generic classes and functions declarations) and PEP 696 (default type parameters). Multi-line support (#11011) is enabled for type parameters list and can be locally controlled on object description directives, e.g., :rst:dir:py:function:single-line-type-parameter-list. Patch by Bénédikt Tran.- #11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis via :confval:
linkcheck_anchors_ignore_for_urlwhile
... (truncated)
e560f63 Bump to 7.1.0 final066e0fa Add translation progress information (#11509)0882914 Target PyPI in create-release.yml21fbee5 Fix OIDC token payload1a403e4 Add informational log messaging258b0ea Revert "Switch to using github.request"f9c89e5 Switch to using github.request52c7f66 Use the correct token minting URL for TestPyPI6079f28 Install twine in PyPI publish workflow3d43b9e Fix github-script syntax in create-release.ymlSourced from sphinx's releases.
Sphinx 7.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
- #11514: Fix
SOURCE_DATE_EPOCHin multi-line copyright footer. Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module,keyword,operator,object,exception,statement, andbuiltin) in the :rst:dir:indexdirective, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinxnow allows the version requirement to be specified as(major, minor).- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_lengthand the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list. Patch by Thomas Louf, Adam Turner, and Jean-François B.- #10983: Support for multiline copyright statements in the footer block. Patch by Stefanie Molin
sphinx.util.display.status_iteratornow clears the current line with ANSI control codes, rather than overprinting with space characters.- #11431: linkcheck: Treat SSL failures as broken links. Patch by Bénédikt Tran
- #11157: Keep the
translatedattribute on translated nodes.- #11451: Improve the traceback displayed when using :option:
sphinx-build -Tin parallel builds. Patch by Bénédikt Tran
... (truncated)
d8d73c1 Bump to 7.1.1 finala54e630 [internationalisation] Update message catalogues8452300 Fix multi-line copyright when SOURCE_DATE_EPOCH is set (#11524)fe08cec bump versione560f63 Bump to 7.1.0 final066e0fa Add translation progress information (#11509)0882914 Target PyPI in create-release.yml21fbee5 Fix OIDC token payload1a403e4 Add informational log messaging258b0ea Revert "Switch to using github.request"Sourced from sphinx's releases.
Sphinx 7.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.2 (released Aug 02, 2023)
Bugs fixed
- #11542: linkcheck: Properly respect :confval:
linkcheck_anchorsand do not spuriously report failures to validate anchors. Patch by James Addison.Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
- #11514: Fix
SOURCE_DATE_EPOCHin multi-line copyright footer. Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module,keyword,operator,object,exception,statement, andbuiltin) in the :rst:dir:indexdirective, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinxnow allows the version requirement to be specified as(major, minor).- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_lengthand the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list.
... (truncated)
320d0b6 Bump to 7.1.2 final06c1339 Ensure that linkcheck_anchors is properly respected (#11544)89808c6 Emend attribution for GH-11431 in CHANGES (#11547)4958d2a Fix flake8 E231 reported linting failure4862da8 Bump versiond8d73c1 Bump to 7.1.1 finala54e630 [internationalisation] Update message catalogues8452300 Fix multi-line copyright when SOURCE_DATE_EPOCH is set (#11524)fe08cec bump versione560f63 Bump to 7.1.0 finalSourced from sphinx's releases.
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()patch, for when calling with keyword arguments.- Fixed membership testing (
in) for the :py:class:strinterface of the asset classes (_CascadingStyleSheetand_JavaScript), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree,includehiddenmay be passed as a string or a boolean.- Fix
:noindex:forPyModuleand JSModule``.Release 7.2.1 (released Aug 17, 2023)
Bugs fixed
- Restored the the :py:class:
strinterface of the asset classes (_CascadingStyleSheetand_JavaScript), which several extensions relied upon. This will be removed in Sphinx 9.- Restored calls to
Builder.add_{css,js}_file(), which several extensions relied upon.- Restored the private API
TocTree.get_toctree_ancestors(), which several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
- #11512: Deprecate
sphinx.util.md5andsphinx.util.sha1. Usehashlibinstead.- #11526: Deprecate
sphinx.testing.path. Useos.pathorpathlibinstead.- #11528: Deprecate
sphinx.util.split_index_msgandsphinx.util.split_into. Usesphinx.util.index_entries.split_index_msginstead.- Deprecate
sphinx.builders.html.Stylesheetandsphinx.builders.html.Javascript. Usesphinx.application.Sphinx.add_css_file()
... (truncated)
ed84d63 Bump to 7.2.2 finalea4a73e [bot]: Update message catalogues (#11612)e47846a Fix :noindex: for PyModule and JSModule``b2fc47f Add CHANGES entry for renaming the StateMachine.insert_input() parameter0835c3e Fix regression in SingleFileHTMLBuilder._get_local_toctree49dc0dd Fix asset class string interface membership testing8512855 Fix signature of docutils include_source monkeypatch (#11610)e1d9068 Bump version441a9e4 Bump to 7.2.1 finalec31853 Restore TocTree.get_toctree_ancestors()Sourced from furo's changelog.
Changelog
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@AA-Turner!- Bump
require_sphinx()to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
... (truncated)
0766bb2 Prepare release: 2023.08.19807d73c Update changelog364b261 Accomodate for the required data-content_root for search0d38bc6 Simplify retrieval of pygments_dark_style value (#699)3631ffc Use sphinx.errors.ConfigError (#697)d2e2448 Remove duplicate HTML builder check (#698)7b4f130 Drop Python 3.7 (#701)e322b71 Remove pointless assert (#702)ee2097a Bump require_sphinx() to Sphinx 6.0 (#700)c1ff10b Back to developmentSourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>__.Expand Markdown detection to all Python language names from Pygments:
py,sage,python3,py3, andnumpy.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>__.Support passing the
--previewoption through to Black, to select the future style.Remove
language_versionfrom.pre-commit-hooks.yaml. This change allowsdefault_language_versionin ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>__.
960ead2 Version 1.16.08f0ed18 Support passing --preview through to Black (#273)4eb4e4c Tweak changelog note6c7450c Use exit code 2 to indicate errors (#272)99dfc8d Preserve leading whitespace lines in rST (#271)94465e8 Reformat markdown tests with dedent() (#270)7cd5f30 Use .md in glob examplef97e569 Document applying to many files (#269)ae612b0 Expand Markdown detection to all Python language names (#268)da9b455 Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.4
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.4 (released Aug 28, 2023)
Bugs fixed
- #11618: Fix a regression in the MoveModuleTargets transform, introduced in #10478 (#9662).
- #11649: linkcheck: Resolve hanging tests for timezones west of London and incorrect conversion from UTC to offsets from the UNIX epoch. Patch by Dmitry Shachnev and Adam Turner.
Release 7.2.3 (released Aug 23, 2023)
Dependencies
- #11576: Require sphinxcontrib-serializinghtml 1.1.9.
Bugs fixed
- Fix regression in
autodoc.Documenter.parse_name().- Fix regression in JSON serialisation.
- #11543: autodoc: Support positional-only parameters in
classmethodmethods whenautodoc_preserve_defaultsisTrue.- Restore support string methods on path objects. This is deprecated and will be removed in Sphinx 8. Use :py:func:
os.fspathto convert :py:class:~pathlib.Pathobjects to strings, or :py:class:~pathlib.Path's methods to work with path objects.Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()patch, for when calling with keyword arguments.- Fixed membership testing (
in) for the :py:class:strinterface of the asset classes (_CascadingStyleSheetand_JavaScript), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree,includehiddenmay be passed as a string or a boolean.- Fix
:noindex:forPyModuleandJSModule.Release 7.2.1 (released Aug 17, 2023)
... (truncated)
3256f1f Bump to 7.2.4 final2f025a4 linkcheck: Fix conversion from UTC time to the UNIX epoch (#11649)1567281 autodoc: Fix UnboundLocalError in filter_members (#11651)5e88b9f Fix the MoveModuleTargets transform (#11647)694fcee Fix markup in CHANGES (#11639)c503c90 Improve pathlib type annotations (#11646)bf339b1 Bump version2f6ea14 Bump to 7.2.3 final511e407 Implement bool() for string paths494de73 Implement hash() for string pathsSourced from furo's changelog.
Changelog
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@AA-Turner!- Bump
require_sphinx()to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
... (truncated)
0766bb2 Prepare release: 2023.08.19807d73c Update changelog364b261 Accomodate for the required data-content_root for search0d38bc6 Simplify retrieval of pygments_dark_style value (#699)3631ffc Use sphinx.errors.ConfigError (#697)d2e2448 Remove duplicate HTML builder check (#698)7b4f130 Drop Python 3.7 (#701)e322b71 Remove pointless assert (#702)ee2097a Bump require_sphinx() to Sphinx 6.0 (#700)c1ff10b Back to developmentSourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>__.Expand Markdown detection to all Python language names from Pygments:
py,sage,python3,py3, andnumpy.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>__.Support passing the
--previewoption through to Black, to select the future style.Remove
language_versionfrom.pre-commit-hooks.yaml. This change allowsdefault_language_versionin ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>__.
960ead2 Version 1.16.08f0ed18 Support passing --preview through to Black (#273)4eb4e4c Tweak changelog note6c7450c Use exit code 2 to indicate errors (#272)99dfc8d Preserve leading whitespace lines in rST (#271)94465e8 Reformat markdown tests with dedent() (#270)7cd5f30 Use .md in glob examplef97e569 Document applying to many files (#269)ae612b0 Expand Markdown detection to all Python language names (#268)da9b455 Replace NamedTuple with plain class (#267)Sourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>__.Expand Markdown detection to all Python language names from Pygments:
py,sage,python3,py3, andnumpy.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>__.Support passing the
--previewoption through to Black, to select the future style.Remove
language_versionfrom.pre-commit-hooks.yaml. This change allowsdefault_language_versionin ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>__.
960ead2 Version 1.16.08f0ed18 Support passing --preview through to Black (#273)4eb4e4c Tweak changelog note6c7450c Use exit code 2 to indicate errors (#272)99dfc8d Preserve leading whitespace lines in rST (#271)94465e8 Reformat markdown tests with dedent() (#270)7cd5f30 Use .md in glob examplef97e569 Document applying to many files (#269)ae612b0 Expand Markdown detection to all Python language names (#268)da9b455 Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.5
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.5 (released Aug 30, 2023)
Bugs fixed
- #11645: Fix a regression preventing autodoc from importing modules within packages that make use of
if typing.TYPE_CHECKING:to guard circular imports needed by type checkers. Patch by Matt Wozniski.- #11634: Fixed inheritance diagram relative link resolution for sibling files in a subdirectory. Patch by Albert Shih.
- #11659: Allow
?config=...in :confval:mathjax_path.- #11654: autodoc: Fail with a more descriptive error message when an object claims to be an instance of
type, but is not a class. Patch by James Braza.- 11620: Cease emitting :event:
source-readevents for files read via the :dudir:includedirective.- 11620: Add a new :event:
include-readfor observing and transforming the content of included files via the :dudir:includedirective.- #11627: Restore support for copyright lines of the form
YYYYwhenSOURCE_DATE_EPOCHis 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 black's releases.
23.10.0
Stable style
- Fix comments getting removed from inside parenthesized strings (#3909)
Preview style
- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)
Configuration
- Fix cache versioning logic when
BLACK_CACHE_DIRis set (#3937)Parser
- Fix bug where attributes named
typewere not acccepted insidematchstatements (#3950)- Add support for PEP 695 type aliases containing lambdas and other unusual expressions (#3949)
Output
- Black no longer attempts to provide special errors for attempting to format Python 2 code (#3933)
- Black will more consistently print stacktraces on internal errors in verbose mode (#3938)
Integrations
- The action output displayed in the job summary is now wrapped in Markdown (#3914)
Sourced from black's changelog.
23.10.0
Stable style
- Fix comments getting removed from inside parenthesized strings (#3909)
Preview style
- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)
Configuration
- Fix cache versioning logic when
BLACK_CACHE_DIRis set (#3937)Parser
- Fix bug where attributes named
typewere not acccepted insidematchstatements (#3950)- Add support for PEP 695 type aliases containing lambdas and other unusual expressions (#3949)
Output
- Black no longer attempts to provide special errors for attempting to format Python 2 code (#3933)
- Black will more consistently print stacktraces on internal errors in verbose mode (#3938)
Integrations
- The action output displayed in the job summary is now wrapped in Markdown (#3914)
9edba85 Prepare release 23.10.0 (#3951)bb58807 Fix parser bug where "type" was misinterpreted as a keyword inside a match (#...722735d Fix grammar for type alias support (#3949)abe57e3 Treat raw strings like other docstrings (#3947)1648ac5 Fix long lines with power operator(s) getting splitted before line length (#3...6f84f65 Migrate mypy config to pyproject.toml (#3936)3bb9214 CI Test: Deprecating 'Healthcheck.all()' from Hypothesis in fuzz.py (#3945)935f303 Fix test that was not being run (#3939)b7717c3 Standardise newlines after module-level docstrings (#3932)7aa37ea Report all stacktraces in verbose mode (#3938)Sourced from black's releases.
23.10.1
Highlights
- Maintanence release to get a fix out for GitHub Action edge case (#3957)
Preview style
- Fix merging implicit multiline strings that have inline comments (#3956)
- Allow empty first line after block open before a comment or compound statement (#3967)
Packaging
- Change Dockerfile to hatch + compile black (#3965)
Integrations
- The summary output for GitHub workflows is now suppressible using the
summaryparameter. (#3958)- Fix the action failing when Black check doesn't pass (#3957)
Documentation
- It is known Windows documentation CI is broken psf/black#3968
23.10.0
Stable style
- Fix comments getting removed from inside parenthesized strings (#3909)
Preview style
- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)
Configuration
- Fix cache versioning logic when
BLACK_CACHE_DIRis set (#3937)Parser
... (truncated)
Sourced from black's changelog.
23.10.1
Highlights
- Maintanence release to get a fix out for GitHub Action edge case (#3957)
Preview style
- Fix merging implicit multiline strings that have inline comments (#3956)
- Allow empty first line after block open before a comment or compound statement (#3967)
Packaging
- Change Dockerfile to hatch + compile black (#3965)
Integrations
- The summary output for GitHub workflows is now suppressible using the
summaryparameter. (#3958)- Fix the action failing when Black check doesn't pass (#3957)
Documentation
- It is known Windows documentation CI is broken psf/black#3968
23.10.0
Stable style
- Fix comments getting removed from inside parenthesized strings (#3909)
Preview style
- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)
Configuration
- Fix cache versioning logic when
BLACK_CACHE_DIRis set (#3937)Parser
- Fix bug where attributes named
typewere not accepted insidematchstatements (#3950)- Add support for PEP 695 type aliases containing lambdas and other unusual expressions
... (truncated)
744d23b Prepare release 23.10.1 (#3969)8de4be5 Fix CI failing (#3957)c0adca3 docs: specifies the use of the .git-blame-ignore-revs file (#3961)a7643fa Add summary parameter to action (#3958)d291c23 Move Docker image to hatch + compile (#3965)7f1c578 Bump peter-evans/create-or-update-comment from 3.0.2 to 3.1.0 (#3966)2db5ab0 Allow empty line after block open before a comment or compound statement (#3967)0a37888 Fix typos in CHANGES.md (#3963)882d879 Fix merging implicit multiline strings that have inline comments (#3956)9edba85 Prepare release 23.10.0 (#3951)Sourced from black's releases.
23.11.0
Highlights
- Support formatting ranges of lines with the new
--line-rangescommand-line option (#4020)Stable style
- Fix crash on formatting bytes strings that look like docstrings (#4003)
- Fix crash when whitespace followed a backslash before newline in a docstring (#4008)
- Fix standalone comments inside complex blocks crashing Black (#4016)
- Fix crash on formatting code like
await (a ** b)(#3994)- No longer treat leading f-strings as docstrings. This matches Python's behaviour and fixes a crash (#4019)
Preview style
- Multiline dicts and lists that are the sole argument to a function are now indented less (#3964)
- Multiline unpacked dicts and lists as the sole argument to a function are now also indented less (#3992)
- In f-string debug expressions, quote types that are visible in the final string are now preserved (#4005)
- Fix a bug where long
caseblocks were not split into multiple lines. Also enable general trailing comma rules oncaseblocks (#4024)- Keep requiring two empty lines between module-level docstring and first function or class definition (#4028)
- Add support for single-line format skip with other comments on the same line (#3959)
Configuration
- Consistently apply force exclusion logic before resolving symlinks (#4015)
- Fix a bug in the matching of absolute path names in
--include(#3976)Performance
- Fix mypyc builds on arm64 on macOS (#4017)
Integrations
- Black's pre-commit integration will now run only on git hooks appropriate for a code formatter (#3940)
23.10.1
Highlights
- Maintanence release to get a fix out for GitHub Action edge case (#3957)
Preview style
... (truncated)
Sourced from black's changelog.
23.11.0
Highlights
- Support formatting ranges of lines with the new
--line-rangescommand-line option (#4020)Stable style
- Fix crash on formatting bytes strings that look like docstrings (#4003)
- Fix crash when whitespace followed a backslash before newline in a docstring (#4008)
- Fix standalone comments inside complex blocks crashing Black (#4016)
- Fix crash on formatting code like
await (a ** b)(#3994)- No longer treat leading f-strings as docstrings. This matches Python's behaviour and fixes a crash (#4019)
Preview style
- Multiline dicts and lists that are the sole argument to a function are now indented less (#3964)
- Multiline unpacked dicts and lists as the sole argument to a function are now also indented less (#3992)
- In f-string debug expressions, quote types that are visible in the final string are now preserved (#4005)
- Fix a bug where long
caseblocks were not split into multiple lines. Also enable general trailing comma rules oncaseblocks (#4024)- Keep requiring two empty lines between module-level docstring and first function or class definition (#4028)
- Add support for single-line format skip with other comments on the same line (#3959)
Configuration
- Consistently apply force exclusion logic before resolving symlinks (#4015)
- Fix a bug in the matching of absolute path names in
--include(#3976)Performance
- Fix mypyc builds on arm64 on macOS (#4017)
Integrations
- Black's pre-commit integration will now run only on git hooks appropriate for a code formatter (#3940)
23.10.1
Highlights
- Maintenance release to get a fix out for GitHub Action edge case (#3957)
... (truncated)
2a1c67e 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 sphinx's releases.
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
- #11512: Deprecate
sphinx.util.md5andsphinx.util.sha1. Usehashlibinstead.- #11526: Deprecate
sphinx.testing.path. Useos.pathorpathlibinstead.- #11528: Deprecate
sphinx.util.split_index_msgandsphinx.util.split_into. Usesphinx.util.index_entries.split_index_msginstead.- Deprecate
sphinx.builders.html.Stylesheetandsphinx.builders.html.Javascript. Usesphinx.application.Sphinx.add_css_file()andsphinx.application.Sphinx.add_js_file()instead.- #11582: Deprecate
sphinx.builders.html.StandaloneHTMLBuilder.css_filesandsphinx.builders.html.StandaloneHTMLBuilder.script_files. Usesphinx.application.Sphinx.add_css_file()andsphinx.application.Sphinx.add_js_file()instead.- #11459: Deprecate
sphinx.ext.autodoc.preserve_defaults.get_function_def(). Patch by Bénédikt Tran.Features added
- #11526: Support
os.PathLiketypes andpathlib.Pathobjects in many more places.- #5474: coverage: Print summary statistics tables. Patch by Jorge Leitao.
- #6319: viewcode: Add :confval:
viewcode_line_numbersto control whether line numbers are added to rendered source code. Patch by Ben Krikler.- #9662: Add the
:no-typesetting:option to suppress textual output and only create a linkable anchor. Patch by Latosha Maltba.- #11221: C++: Support domain objects in the table of contents. Patch by Rouslan Korneychuk.
- #10938: doctest: Add :confval:
doctest_show_successesoption. Patch by Trey Hunner.- #11533: Add
:no-index:,:no-index-entry:, and:no-contents-entry:.- #11572: Improve
debuglogging of reasons why files are detected as out of date. Patch by Eric Larson.
... (truncated)
da9f8a5 Bump to 7.2.0 final794324a Declare support for Python 3.1303bceac [bot]: Update message catalogues (#11538)aecebce Make _resolve_toctree() keyword-only76658c4 Fix sphinx.ext.autodoc.preserve_defaults (#11550)4dee162 Fix layout issues in the agogo theme for smaller viewports (#11594)4ddbee4 Fix console_scripts entry points4add50a Remove unneeded type annotation9d8ef83 Fix test_inspect_main_noargsddf8a8e Add CHANGES entry for GH-11533Sourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>__.Expand Markdown detection to all Python language names from Pygments:
py,sage,python3,py3, andnumpy.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>__.Support passing the
--previewoption through to Black, to select the future style.Remove
language_versionfrom.pre-commit-hooks.yaml. This change allowsdefault_language_versionin ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>__.
960ead2 Version 1.16.08f0ed18 Support passing --preview through to Black (#273)4eb4e4c Tweak changelog note6c7450c Use exit code 2 to indicate errors (#272)99dfc8d Preserve leading whitespace lines in rST (#271)94465e8 Reformat markdown tests with dedent() (#270)7cd5f30 Use .md in glob examplef97e569 Document applying to many files (#269)ae612b0 Expand Markdown detection to all Python language names (#268)da9b455 Replace NamedTuple with plain class (#267)Sourced from furo's changelog.
Changelog
2023.09.10 -- Zesty Zaffre
- Make asset hash injection idempotent, fixing Sphinx 6 compatibility.
- Fix the check for HTML builders, fixing non-HTML Read the Docs builds.
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@AA-Turner!- Bump
require_sphinx()to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
... (truncated)
2718ca4 Prepare release: 2023.09.10c22c99d Update changelogc37e849 Quote a not-runtime-generic type annotation9cfdf44 Rework infrastructure for linting5abeb9f Fix the check for HTML buildersee2ab54 Tweak how tests are run with noxcdae236 Test against Sphinx minor versions in CI9e40071 Make asset hash injection idempotentaab86f4 Revert "Exclude incompatible Sphinx releases (#711)"4dd6eec Exclude incompatible Sphinx releases (#711)Sourced from black's releases.
23.9.1
Due to various issues, the previous release (23.9.0) did not include compiled mypyc wheels, which make Black significantly faster. These issues have now been fixed, and this release should come with compiled wheels once again.
There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12 wheels in a future release as soon as the mypyc bug is fixed.
Packaging
- Upgrade to mypy 1.5.1 (#3864)
Performance
- Store raw tuples instead of NamedTuples in Black's cache, improving performance and decreasing the size of the cache (#3877)
23.9.0
Preview style
- More concise formatting for dummy implementations (#3796)
- In stub files, add a blank line between a statement with a body (e.g an
if sys.version_info > (3, x):) and a function definition on the same level (#3862)- Fix a bug whereby spaces were removed from walrus operators within subscript(#3823)
Configuration
- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
Performance
- Avoid importing
IPythonif notebook cells do not contain magics (#3782)- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
Blackd
- Fix an issue in
blackdwith single character input (#3558)Integrations
- Black now has an official pre-commit mirror. Swapping
https://github.com/psf/blacktohttps://github.com/psf/black-pre-commit-mirrorin your.pre-commit-config.yamlwill make Black about 2x faster (#3828)- The
.black.envfolder specified byENV_PATHwill now be removed on the completion of the GitHub Action (#3759)
Sourced from black's changelog.
23.9.1
Due to various issues, the previous release (23.9.0) did not include compiled mypyc wheels, which make Black significantly faster. These issues have now been fixed, and this release should come with compiled wheels once again.
There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12 wheels in a future release as soon as the mypyc bug is fixed.
Packaging
- Upgrade to mypy 1.5.1 (#3864)
Performance
- Store raw tuples instead of NamedTuples in Black's cache, improving performance and decreasing the size of the cache (#3877)
23.9.0
Preview style
- More concise formatting for dummy implementations (#3796)
- In stub files, add a blank line between a statement with a body (e.g an
if sys.version_info > (3, x):) and a function definition on the same level (#3862)- Fix a bug whereby spaces were removed from walrus operators within subscript(#3823)
Configuration
- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
Performance
- Avoid importing
IPythonif notebook cells do not contain magics (#3782)- Improve caching by comparing file hashes as fallback for mtime and size (#3821)
Blackd
- Fix an issue in
blackdwith single character input (#3558)Integrations
- Black now has an official pre-commit mirror. Swapping
https://github.com/psf/blacktohttps://github.com/psf/black-pre-commit-mirrorin your.pre-commit-config.yamlwill make Black about 2x faster (#3828)- The
.black.envfolder specified byENV_PATHwill now be removed on the completion of the GitHub Action (#3759)
e877371 Prepare release 23.9.1 (#3878)62dca32 mypyc builds on PRs, skip mypyc wheels for 3.12 (#3870)751583a Pickle raw tuples in FileData cache (#3877)f791745 Re-export black.Mode (#3875)0b62b9c Ignore aiohttp DeprecationWarning for 3.12 (#3876)c83ad6c Upgrade to Furo 2023.9.10 to fix docs build (#3873)4eebfd1 Add mypyc test marks to new tests that patch (#3871)add161b Bump RTD Python version from 3.8 to 3.11 (#3868)4e93f2a Add classifier for 3.12 (#3866)716fa08 Upgrade mypy (#3864)Sourced from sphinx's releases.
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()patch, for when calling with keyword arguments.- Fixed membership testing (
in) for the :py:class:strinterface of the asset classes (_CascadingStyleSheetand_JavaScript), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree,includehiddenmay be passed as a string or a boolean.- Fix
:noindex:forPyModuleand JSModule``.Release 7.2.1 (released Aug 17, 2023)
Bugs fixed
- Restored the the :py:class:
strinterface of the asset classes (_CascadingStyleSheetand_JavaScript), which several extensions relied upon. This will be removed in Sphinx 9.- Restored calls to
Builder.add_{css,js}_file(), which several extensions relied upon.- Restored the private API
TocTree.get_toctree_ancestors(), which several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
- #11512: Deprecate
sphinx.util.md5andsphinx.util.sha1. Usehashlibinstead.- #11526: Deprecate
sphinx.testing.path. Useos.pathorpathlibinstead.- #11528: Deprecate
sphinx.util.split_index_msgandsphinx.util.split_into. Usesphinx.util.index_entries.split_index_msginstead.- Deprecate
sphinx.builders.html.Stylesheetandsphinx.builders.html.Javascript. Usesphinx.application.Sphinx.add_css_file()
... (truncated)
ed84d63 Bump to 7.2.2 finalea4a73e [bot]: Update message catalogues (#11612)e47846a Fix :noindex: for PyModule and JSModule``b2fc47f Add CHANGES entry for renaming the StateMachine.insert_input() parameter0835c3e Fix regression in SingleFileHTMLBuilder._get_local_toctree49dc0dd Fix asset class string interface membership testing8512855 Fix signature of docutils include_source monkeypatch (#11610)e1d9068 Bump version441a9e4 Bump to 7.2.1 finalec31853 Restore TocTree.get_toctree_ancestors()Sourced from furo's changelog.
Changelog
2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
... (truncated)
Sourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>__.Expand Markdown detection to all Python language names from Pygments:
py,sage,python3,py3, andnumpy.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>__.Support passing the
--previewoption through to Black, to select the future style.Remove
language_versionfrom.pre-commit-hooks.yaml. This change allowsdefault_language_versionin ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>__.
960ead2 Version 1.16.08f0ed18 Support passing --preview through to Black (#273)4eb4e4c Tweak changelog note6c7450c Use exit code 2 to indicate errors (#272)99dfc8d Preserve leading whitespace lines in rST (#271)94465e8 Reformat markdown tests with dedent() (#270)7cd5f30 Use .md in glob examplef97e569 Document applying to many files (#269)ae612b0 Expand Markdown detection to all Python language names (#268)da9b455 Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.3 (released Aug 23, 2023)
Dependencies
- #11576: Require sphinxcontrib-serializinghtml 1.1.9.
Bugs fixed
- Fix regression in
autodoc.Documenter.parse_name().- Fix regression in JSON serialisation.
- #11543: autodoc: Support positional-only parameters in
classmethodmethods whenautodoc_preserve_defaultsisTrue.- Restore support string methods on path objects. This is deprecated and will be removed in Sphinx 8. Use :py:func
os.fspathto convert :py:class:pathlib.Pathobjects to strings, or :py:class:pathlib.Path's methods to work with path objects.Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()patch, for when calling with keyword arguments.- Fixed membership testing (
in) for the :py:class:strinterface of the asset classes (_CascadingStyleSheetand_JavaScript), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree,includehiddenmay be passed as a string or a boolean.- Fix
:noindex:forPyModuleand JSModule``.Release 7.2.1 (released Aug 17, 2023)
Bugs fixed
- Restored the the :py:class:
strinterface of the asset classes (_CascadingStyleSheetand_JavaScript), which several extensions relied upon. This will be removed in Sphinx 9.- Restored calls to
Builder.add_{css,js}_file(), which several extensions relied upon.- Restored the private API
TocTree.get_toctree_ancestors(), which several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
... (truncated)
2f6ea14 Bump to 7.2.3 final511e407 Implement bool() for string paths494de73 Implement hash() for string paths2986aa1 Override special methods for string paths07b87e9 Update CHANGES for 7.2.36b17dd1 Support string methods on path objects (#11619)a73fb59 Support positional-only parameters in classmethods (#11635)02cb02c Fix invocation of python -m sphinx build6183b6a Require sphinxcontrib-serializinghtml 1.1.9 or later1e16f21 Fix regression in autodoc.Documenter.parse_name (#11613)Sourced from furo's changelog.
Changelog
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@AA-Turner!- Bump
require_sphinx()to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
... (truncated)
0766bb2 Prepare release: 2023.08.19807d73c Update changelog364b261 Accomodate for the required data-content_root for search0d38bc6 Simplify retrieval of pygments_dark_style value (#699)3631ffc Use sphinx.errors.ConfigError (#697)d2e2448 Remove duplicate HTML builder check (#698)7b4f130 Drop Python 3.7 (#701)e322b71 Remove pointless assert (#702)ee2097a Bump require_sphinx() to Sphinx 6.0 (#700)c1ff10b Back to developmentSourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>__.Expand Markdown detection to all Python language names from Pygments:
py,sage,python3,py3, andnumpy.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>__.Support passing the
--previewoption through to Black, to select the future style.Remove
language_versionfrom.pre-commit-hooks.yaml. This change allowsdefault_language_versionin ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>__.
960ead2 Version 1.16.08f0ed18 Support passing --preview through to Black (#273)4eb4e4c Tweak changelog note6c7450c Use exit code 2 to indicate errors (#272)99dfc8d Preserve leading whitespace lines in rST (#271)94465e8 Reformat markdown tests with dedent() (#270)7cd5f30 Use .md in glob examplef97e569 Document applying to many files (#269)ae612b0 Expand Markdown detection to all Python language names (#268)da9b455 Replace NamedTuple with plain class (#267)