id,node_id,number,title,user,state,locked,assignee,milestone,comments,created_at,updated_at,closed_at,author_association,pull_request,body,repo,type,active_lock_reason,performed_via_github_app,reactions,draft,state_reason
273595473,MDExOlB1bGxSZXF1ZXN0MTUyMzYwNzQw,81,:fire: Removes DS_Store,50527,closed,0,,,2,2017-11-13T22:07:52Z,2017-11-14T02:24:54Z,2017-11-13T22:16:55Z,CONTRIBUTOR,simonw/datasette/pulls/81,,107914493,pull,,,"{""url"": ""https://api.github.com/repos/simonw/datasette/issues/81/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
332998752,MDExOlB1bGxSZXF1ZXN0MTk1MzM5MTEx,311,"?_labels=1 to expand foreign keys (in csv and json), refs #233",9599,closed,0,,,2,2018-06-16T16:31:12Z,2018-06-16T22:20:31Z,2018-06-16T22:20:31Z,OWNER,simonw/datasette/pulls/311,"Output looks something like this:
{
""rowid"": 233,
""TreeID"": 121240,
""qLegalStatus"": {
""value"" 2,
""label"": ""Private""
}
""qSpecies"": {
""value"": 16,
""label"": ""Sycamore""
}
""qAddress"": ""91 Commonwealth Ave"",
...
}",107914493,pull,,,"{""url"": ""https://api.github.com/repos/simonw/datasette/issues/311/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
825217564,MDExOlB1bGxSZXF1ZXN0NTg3MzMyNDcz,1252,Add back styling to lists within table cells (fixes #1141),7476523,closed,0,,,2,2021-03-09T03:00:57Z,2021-03-29T00:14:04Z,2021-03-29T00:14:04Z,CONTRIBUTOR,simonw/datasette/pulls/1252,"This overrides the Datasette reset - see https://github.com/simonw/datasette/blob/d0fd833b8cdd97e1b91d0f97a69b494895d82bee/datasette/static/app.css#L35-L38 - to add back the default styling of list items displayed within Datasette table cells.
Following this change, the same content as in the original issue looks like this:
![2021-03-09_02:57:32](https://user-images.githubusercontent.com/7476523/110411982-63e5ae80-8083-11eb-9b5c-e5dc825073e2.png)
",107914493,pull,,,"{""url"": ""https://api.github.com/repos/simonw/datasette/issues/1252/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
806918878,MDExOlB1bGxSZXF1ZXN0NTcyMjU0MTAz,1223,Add compile option to Dockerfile to fix failing test (fixes #696),7476523,closed,0,,,2,2021-02-12T03:38:05Z,2021-03-07T12:01:12Z,2021-03-07T07:41:17Z,CONTRIBUTOR,simonw/datasette/pulls/1223,"This test was failing when run inside the Docker container: `test_searchable[/fixtures/searchable.json?_search=te*+AND+do*&_searchmode=raw-expected_rows3]`,
with this error:
```
def test_searchable(app_client, path, expected_rows):
response = app_client.get(path)
> assert expected_rows == response.json[""rows""]
E AssertionError: assert [[1, 'barry c...sel', 'puma']] == []
E Left contains 2 more items, first extra item: [1, 'barry cat', 'terry dog', 'panther']
E Full diff:
E + []
E - [[1, 'barry cat', 'terry dog', 'panther'],
E - [2, 'terry dog', 'sara weasel', 'puma']]
```
The issue was that the version of sqlite3 built inside the Docker container was built with FTS3 and FTS4 enabled, but without the
`SQLITE_ENABLE_FTS3_PARENTHESIS` compile option passed, which adds support for using `AND` and `NOT` within `match` expressions (see https://sqlite.org/fts3.html#compiling_and_enabling_fts3_and_fts4 and https://www.sqlite.org/compile.html).
Without this, the `AND` used in the search in this test was being interpreted as a literal string, and so no matches were found. Adding this compile option fixes this.
---
I actually ran into this issue because the same test was failing when I ran the test suite on my own machine, outside of Docker, and so I eventually tracked this down to my system sqlite3 also being compiled without this option.
I wonder if this is a sign of a slightly deeper issue, that Datasette can silently behave differently based on the version and compilation of sqlite3 it is being used with. On my own system I fixed the test suite by running `pip install pysqlite3-binary`, so that this would be picked up instead of the `sqlite` package, as this seems to be compiled using this option, . Maybe using `pysqlite3-binary` could be installed/recommended by default so a more deterministic version of sqlite is used? Or there could be some feature detection done on the available sqlite version, to know what features are available and can be used/tested?",107914493,pull,,,"{""url"": ""https://api.github.com/repos/simonw/datasette/issues/1223/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
1388227245,PR_kwDOBm6k_c4_uCkO,1825,Add documentation for serving via OpenRC,1048831,closed,0,,,2,2022-09-27T19:00:56Z,2022-09-28T04:21:37Z,2022-09-28T04:21:37Z,CONTRIBUTOR,simonw/datasette/pulls/1825,"I also removed a few lines which felt redundant given the following section dedicated to running behind a nginx proxy.
----
:books: Documentation preview :books:: https://datasette--1825.org.readthedocs.build/en/1825/
",107914493,pull,,,"{""url"": ""https://api.github.com/repos/simonw/datasette/issues/1825/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
1503010009,PR_kwDOBm6k_c5FyT3c,1967,Add favicon to documentation,1839645,closed,0,,,2,2022-12-19T14:01:04Z,2022-12-31T19:15:51Z,2022-12-31T19:00:31Z,CONTRIBUTOR,simonw/datasette/pulls/1967,"I've been browsing the datasette documentation and found it hard to quickly locate tabs with many of them open, because it does not ship a favicon. So this PR:
- Grabs the favicon `.png` from datasette itself[^1]
- Adds it to the `_static/` folder
- Sets `html_favicon` to load it in the docs
[^1]: I also learned that Chrome can fetch favicons as an internal service! See `chrome://favicon/https://datasette.io/tools/github-to-sqlite`.
",107914493,pull,,,"{""url"": ""https://api.github.com/repos/simonw/datasette/issues/1967/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
792297010,MDExOlB1bGxSZXF1ZXN0NTYwMjA0MzA2,224,Add fts offset docs.,37962604,closed,0,,,2,2021-01-22T20:50:58Z,2021-02-14T19:31:06Z,2021-02-14T19:31:06Z,NONE,simonw/sqlite-utils/pulls/224,"The limit can be passed as a string to the query builder to have an offset. I have tested it using the shorthand `limit=f""15, 30""`, the standard syntax should work too.",140912432,pull,,,"{""url"": ""https://api.github.com/repos/simonw/sqlite-utils/issues/224/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
438048318,MDExOlB1bGxSZXF1ZXN0Mjc0MTc0NjE0,437,Add inspect and prepare_sanic hooks,45057,closed,0,,,2,2019-04-28T11:53:34Z,2019-06-24T16:38:57Z,2019-06-24T16:38:56Z,CONTRIBUTOR,simonw/datasette/pulls/437,"This adds two new plugin hooks:
The `inspect` hook allows plugins to add data to the inspect dictionary.
The `prepare_sanic` hook allows plugins to hook into the web router. I've attached a warning to this hook in the docs in light of #272 but I want this hook now...
On quick inspection, I don't think it's worthwhile to try and make this hook independent of the web framework (but it looks like Starlette would make the hook implementation a bit nicer).
Ref #14",107914493,pull,,,"{""url"": ""https://api.github.com/repos/simonw/datasette/issues/437/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
727916744,MDExOlB1bGxSZXF1ZXN0NTA4NzIwNjYw,1044,Add minimum supported python,45380,closed,0,,,2,2020-10-23T05:08:03Z,2020-10-23T20:53:08Z,2020-10-23T20:53:08Z,CONTRIBUTOR,simonw/datasette/pulls/1044,"Thanks for `datasette`!
This PR adds `python_requires` to formally signal the [minimum supported python version](https://packaging.python.org/guides/dropping-older-python-versions/#specify-the-version-ranges-for-supported-python-distributions) (which is pointed out with classifiers, so seems pretty straightforward).",107914493,pull,,,"{""url"": ""https://api.github.com/repos/simonw/datasette/issues/1044/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
681228542,MDExOlB1bGxSZXF1ZXN0NDY5NjUxNzMy,48,Add pull requests,755825,closed,0,,,2,2020-08-18T17:58:44Z,2020-11-29T23:51:09Z,2020-11-29T23:51:09Z,CONTRIBUTOR,dogsheep/github-to-sqlite/pulls/48,"ref #46
Issues don't have merge information on them, which means that PRs need to be pulled separately.
Did my best to mimic the API of issues.",207052882,pull,,,"{""url"": ""https://api.github.com/repos/dogsheep/github-to-sqlite/issues/48/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
1213281044,PR_kwDOBm6k_c42qyUI,1717,Add timeout option to Cloudrun build,127565,closed,0,,,2,2022-04-23T11:51:21Z,2022-04-24T14:03:08Z,2022-04-24T14:03:08Z,CONTRIBUTOR,simonw/datasette/pulls/1717,I've found that the Cloudrun build phase often hits a timeout limit with large databases. I believe the default timeout is 10 minutes. This pull request just adds a `--timeout` option to the cloudrun `publish` command and passes the value on to the build step.,107914493,pull,,,"{""url"": ""https://api.github.com/repos/simonw/datasette/issues/1717/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
589801352,MDExOlB1bGxSZXF1ZXN0Mzk1MjU4Njg3,96,Add type conversion for Panda's Timestamp,32605365,closed,0,,,2,2020-03-29T14:13:09Z,2020-03-31T04:40:49Z,2020-03-31T04:40:48Z,CONTRIBUTOR,simonw/sqlite-utils/pulls/96,"Add type conversion for Panda's Timestamp, if Panda library is present in system
(thanks for this project, I was about to do the same thing from scratch)",140912432,pull,,,"{""url"": ""https://api.github.com/repos/simonw/sqlite-utils/issues/96/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
712889459,MDExOlB1bGxSZXF1ZXN0NDk2Mjk4MTgw,986,"Allow facet by primary keys, fixes #985",39452697,closed,0,,,2,2020-10-01T14:18:55Z,2020-10-01T16:51:45Z,2020-10-01T16:51:45Z,NONE,simonw/datasette/pulls/986,"Hello! This PR makes it possible to facet by primary keys.
Did I get it right that just removing the condition on UI side is enough? From testing it works fine with primary keys, just as with normal keys.
If so, should I also remove unused `data-is-pk`?",107914493,pull,,,"{""url"": ""https://api.github.com/repos/simonw/datasette/issues/986/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
1430563092,PR_kwDOCGYnMM5B6_6K,508,Allow surrogates in parameters,7908073,closed,0,,,2,2022-10-31T22:11:49Z,2022-11-17T15:11:16Z,2022-10-31T22:55:36Z,CONTRIBUTOR,simonw/sqlite-utils/pulls/508,"closes #507
https://dwheeler.com/essays/fixing-unix-linux-filenames.html
----
:books: Documentation preview :books:: https://sqlite-utils--508.org.readthedocs.build/en/508/
",140912432,pull,,,"{""url"": ""https://api.github.com/repos/simonw/sqlite-utils/issues/508/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
1718550688,PR_kwDOCGYnMM5Q9VH0,546,"Analyze tables options: --common-limit, --no-most, --no-least",9599,closed,0,,,2,2023-05-21T15:54:39Z,2023-05-21T16:19:30Z,2023-05-21T16:19:30Z,OWNER,simonw/sqlite-utils/pulls/546,"Refs #544
- [x] Documentation for CLI options
- [x] Documentation for new Python API parameters: `most_common: bool` and `least_common: bool`
- [x] Tests for CLI
- [x] Tests for Python API",140912432,pull,,,"{""url"": ""https://api.github.com/repos/simonw/sqlite-utils/issues/546/reactions"", ""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",0,
869237023,MDExOlB1bGxSZXF1ZXN0NjI0NjM1NDQw,1309,Bump black from 20.8b1 to 21.4b0,27856297,closed,0,,,2,2021-04-27T20:28:11Z,2021-04-28T18:26:06Z,2021-04-28T18:26:04Z,CONTRIBUTOR,simonw/datasette/pulls/1309,"Bumps [black](https://github.com/psf/black) from 20.8b1 to 21.4b0.
Sourced from black's releases. Fixed a rare but annoying formatting instability created by the combination of
optional trailing commas inserted by Added 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 speed up caching by avoiding pathlib (#1950) Added Lines ending with PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher ... (truncated) Sourced from black's changelog. Fixed a rare but annoying formatting instability created by the combination of
optional trailing commas inserted by Added 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 speed up caching by avoiding pathlib (#1950) Added Lines ending with PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher ... (truncated) Sourced from black's releases. Fix crash on docstrings ending with "\ ". (#2142) Fix crash when atypical whitespace is cleaned out of dostrings (#2120) Reflect the Don't remove necessary parentheses from assignment expression containing assert /
return statements. (#2143) Fixed a rare but annoying formatting instability created by the combination of
optional trailing commas inserted by Added 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. Fix crash on docstrings ending with "\ ". (#2142) Fix crash when atypical whitespace is cleaned out of dostrings (#2120) Reflect the Don't remove necessary parentheses from assignment expression containing assert /
return statements. (#2143) Fixed a rare but annoying formatting instability created by the combination of
optional trailing commas inserted by Added 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. Fix crash if the user configuration directory is inaccessible. (#2158) Clarify
circumstances
in which Black may change the AST (#2159) Fix crash on docstrings ending with "\ ". (#2142) Fix crash when atypical whitespace is cleaned out of dostrings (#2120) Reflect the Don't remove necessary parentheses from assignment expression containing assert /
return statements. (#2143) Fixed a rare but annoying formatting instability created by the combination of
optional trailing commas inserted by ... (truncated) Sourced from black's changelog. Fix crash if the user configuration directory is inaccessible. (#2158) Clarify
circumstances
in which Black may change the AST (#2159) Fix crash on docstrings ending with "\ ". (#2142) Fix crash when atypical whitespace is cleaned out of dostrings (#2120) Reflect the Don't remove necessary parentheses from assignment expression containing assert /
return statements. (#2143) Fixed a rare but annoying formatting instability created by the combination of
optional trailing commas inserted by ... (truncated) Sourced from black's releases. 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. ... (truncated) Sourced from black's changelog. 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. ... (truncated) Sourced from black's releases. Sourced from black's changelog. Sourced from black's releases. Sourced from black's changelog. Sourced from black's releases. Sourced from black's changelog. Sourced from black's releases. Sourced from black's changelog. Sourced from black's releases. 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 In addition to style changes, Black now automatically infers the supported Python versions from your ... (truncated) Sourced from black's changelog. 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 In addition to style changes, Black now automatically infers the supported Python
versions from your ... (truncated) Sourced from furo's changelog. ... (truncated) Sourced from furo's changelog. ... (truncated) Sourced from furo's changelog. ... (truncated) Sourced from sphinx's releases. Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Sourced from sphinx's changelog. #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
The first option is to use the sphinxcontrib.jquery_ extension, which has been
developed by the Sphinx team and contributors. To use this, add
The second option is to manually ensure that the frameworks are present.
To re-add jQuery and underscore.js, you will need to copy .. 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: #10901: C Domain: Remove support for parsing pre-v3 style type directives and
roles. Also remove associated configuration variables ... (truncated) Sourced from sphinx's releases. Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Sourced from sphinx's changelog. Adopted the .. _Ruff: https://github.com/charliermarsh/ruff Moved to Moved to Moved to ... (truncated) Sourced from sphinx's releases. Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Sourced from sphinx's changelog. Adopted the .. _Ruff: https://github.com/charliermarsh/ruff Moved to Moved to Moved to ... (truncated) Sourced from sphinx's releases. Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Sourced from sphinx's changelog. .. _Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04 ... (truncated) Sourced from sphinx's releases. Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Sourced from sphinx's changelog. Releases are no longer signed, given the .. _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/ ... (truncated) Sourced from sphinx's releases. Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Sourced from sphinx's changelog. Releases are no longer signed, given the .. _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/ ... (truncated) Sourced from sphinx's releases. Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Sourced from sphinx's changelog. Releases are no longer signed, given the .. _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/ ... (truncated) Sourced from blacken-docs's changelog. Allow Markdown fence options. Thanks to initial work from Matthew Anderson in Expand Markdown detection to all Python language names from Pygments: Preserve leading whitespace lines in reStructuredText code blocks. Thanks to Julianus Pfeuffer for the report in 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 Support passing the Remove Thanks to Aneesh Agrawal in Sourced from black's releases. ... (truncated) Sourced from black's changelog. ... (truncated) Sourced from sphinx's releases. Changelog: https://www.sphinx-doc.org/en/master/changes.html Sourced from sphinx's changelog. ... (truncated) Sourced from blacken-docs's changelog. Allow Markdown fence options. Thanks to initial work from Matthew Anderson in Expand Markdown detection to all Python language names from Pygments: Preserve leading whitespace lines in reStructuredText code blocks. Thanks to Julianus Pfeuffer for the report in 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 Support passing the Remove Thanks to Aneesh Agrawal in Sourced from sphinx's releases. Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Changelog: https://www.sphinx-doc.org/en/master/changes.html Sourced from sphinx's changelog. ... (truncated) Sourced from furo's changelog. ... (truncated) Sourced from blacken-docs's changelog. Allow Markdown fence options. Thanks to initial work from Matthew Anderson in Expand Markdown detection to all Python language names from Pygments: Preserve leading whitespace lines in reStructuredText code blocks. Thanks to Julianus Pfeuffer for the report in 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 Support passing the Remove Thanks to Aneesh Agrawal in Release notes
21.4b0
Black
Black
and optional parentheses looking at
pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
duplicates. (#2126)Black
now processes one-line docstrings by stripping leading and trailing spaces,
and adding a padding space when needed to break up """". (#1740)Black
now cleans up leading non-breaking spaces in comments (#2092)Black
now respects --skip-string-normalization
when normalizing multiline
docstring quotes (#1637)Black
no longer removes all empty lines between non-function code and decorators
when formatting typing stubs. Now Black
enforces a single empty line. (#1646)Black
no longer adds an incorrect space after a parenthesized assignment expression
in if/while statements (#1655)--skip-magic-trailing-comma
/ -C
to avoid using trailing commas as a reason
to split lines (#1824)--extend-exclude
argument (PR #2005)--diff
correctly indicates when a file doesn't end in a newline (#1662)--stdin-filename
argument to allow stdin to respect --force-exclude
rules
(#1780)fmt: skip
will now be not formatted (#1800)Changelog
21.4b0
Black
Black
and optional parentheses looking at
pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
duplicates. (#2126)Black
now processes one-line docstrings by stripping leading and trailing spaces,
and adding a padding space when needed to break up """". (#1740)Black
now cleans up leading non-breaking spaces in comments (#2092)Black
now respects --skip-string-normalization
when normalizing multiline
docstring quotes (#1637)Black
no longer removes all empty lines between non-function code and decorators
when formatting typing stubs. Now Black
enforces a single empty line. (#1646)Black
no longer adds an incorrect space after a parenthesized assignment expression
in if/while statements (#1655)--skip-magic-trailing-comma
/ -C
to avoid using trailing commas as a reason
to split lines (#1824)--extend-exclude
argument (PR #2005)--diff
correctly indicates when a file doesn't end in a newline (#1662)--stdin-filename
argument to allow stdin to respect --force-exclude
rules
(#1780)fmt: skip
will now be not formatted (#1800)Commits
[![Dependabot compatibility score](https://api.dependabot.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=20.8b1&new-version=21.4b0)](https://dependabot.com/compatibility-score/?dependency-name=black&package-manager=pip&previous-version=20.8b1&new-version=21.4b0)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language
- `@dependabot badge me` will comment on this PR with code to add a ""Dependabot enabled"" badge to your readme
Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com):
- Update frequency (including time of day and day of week)
- Pull request limits (per update run and/or open at any time)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)
Release notes
21.4b1
Black
--skip-magic-trailing-comma
and --experimental-string-processing
flags
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)Packaging
21.4b0
Black
Black
and optional parentheses looking at
pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
duplicates. (#2126)Black
now processes one-line docstrings by stripping leading and trailing spaces,
and adding a padding space when needed to break up """". (#1740)Black
now cleans up leading non-breaking spaces in comments (#2092)Black
now respects --skip-string-normalization
when normalizing multiline
docstring quotes (#1637)Black
no longer removes all empty lines between non-function code and decorators
when formatting typing stubs. Now Black
enforces a single empty line. (#1646)Black
no longer adds an incorrect space after a parenthesized assignment expression
in if/while statements (#1655)--skip-magic-trailing-comma
/ -C
to avoid using trailing commas as a reason
to split lines (#1824)Changelog
21.4b1
Black
--skip-magic-trailing-comma
and --experimental-string-processing
flags
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)Packaging
21.4b0
Black
Black
and optional parentheses looking at
pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
duplicates. (#2126)Black
now processes one-line docstrings by stripping leading and trailing spaces,
and adding a padding space when needed to break up """". (#1740)Black
now cleans up leading non-breaking spaces in comments (#2092)Black
now respects --skip-string-normalization
when normalizing multiline
docstring quotes (#1637)Black
no longer removes all empty lines between non-function code and decorators
when formatting typing stubs. Now Black
enforces a single empty line. (#1646)Black
no longer adds an incorrect space after a parenthesized assignment expression
in if/while statements (#1655)--skip-magic-trailing-comma
/ -C
to avoid using trailing commas as a reason
to split lines (#1824)Commits
[![Dependabot compatibility score](https://api.dependabot.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=20.8b1&new-version=21.4b1)](https://dependabot.com/compatibility-score/?dependency-name=black&package-manager=pip&previous-version=20.8b1&new-version=21.4b1)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language
- `@dependabot badge me` will comment on this PR with code to add a ""Dependabot enabled"" badge to your readme
Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com):
- Update frequency (including time of day and day of week)
- Pull request limits (per update run and/or open at any time)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)
Release notes
21.4b2
Black
Packaging
primer.json
(used by black-primer
by default) with black. (#2154)21.4b1
Black
--skip-magic-trailing-comma
and --experimental-string-processing
flags
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)Packaging
21.4b0
Black
Black
and optional parentheses looking at
pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
duplicates. (#2126)Black
now processes one-line docstrings by stripping leading and trailing spaces,
and adding a padding space when needed to break up """". (#1740)Black
now cleans up leading non-breaking spaces in comments (#2092)Black
now respects --skip-string-normalization
when normalizing multiline
docstring quotes (#1637)Black
no longer removes all empty lines between non-function code and decorators
when formatting typing stubs. Now Black
enforces a single empty line. (#1646)Changelog
21.4b2
Black
Packaging
primer.json
(used by black-primer
by default) with black. (#2154)21.4b1
Black
--skip-magic-trailing-comma
and --experimental-string-processing
flags
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)Packaging
21.4b0
Black
Black
and optional parentheses looking at
pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
duplicates. (#2126)Black
now processes one-line docstrings by stripping leading and trailing spaces,
and adding a padding space when needed to break up """". (#1740)Black
now cleans up leading non-breaking spaces in comments (#2092)Black
now respects --skip-string-normalization
when normalizing multiline
docstring quotes (#1637)Commits
[![Dependabot compatibility score](https://api.dependabot.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=20.8b1&new-version=21.4b2)](https://dependabot.com/compatibility-score/?dependency-name=black&package-manager=pip&previous-version=20.8b1&new-version=21.4b2)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language
- `@dependabot badge me` will comment on this PR with code to add a ""Dependabot enabled"" badge to your readme
Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com):
- Update frequency (including time of day and day of week)
- Pull request limits (per update run and/or open at any time)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)
Release notes
22.1.0
Highlights
Style
--experimental-string-processing
and move the functionality under --preview
(#2789)Parser
case {"key": 1 | 2 as password}
(#2686)case 1 as a, 2 as b
(#2716)case Foo(bar=baz as quux)
(#2749)return
and yield
constructs now implies 3.8+ (#2700)values: Tuple[int, ...] = 1, 2, 3
) now implies 3.8+ (#2708)match()
or case()
when there is a trailing newline or a comment inside of the parentheses. (#2760)from __future__ import annotations
statement now implies Python 3.7+ (#2690)Performance
--target-version
is set to 3.10 and higher). (#2728)Configuration
python-cell-magics
) to format cells with custom magics in Jupyter Notebooks (#2744)BLACK_CACHE_DIR
(#2739).-target-version=py310
. (#2758)SRC
or --code
mandatory and mutually exclusive (#2804)Output
Packaging
Changelog
22.1.0
Highlights
Style
--experimental-string-processing
and move the functionality under
--preview
(#2789)if
statements (#2820)Parser
case {"key": 1 | 2 as password}
(#2686)case 1 as a, 2 as b
(#2716)case Foo(bar=baz as quux)
(#2749)return
and yield
constructs now implies 3.8+ (#2700)values: Tuple[int, ...] = 1, 2, 3
) now implies 3.8+ (#2708)match()
or case()
when there is a trailing newline or a
comment inside of the parentheses. (#2760)from __future__ import annotations
statement now implies Python 3.7+ (#2690)Performance
Commits
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=21.12b0&new-version=22.1.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
21.5b0
Black
--pyi
mode if --stdin-filename
ends in .pyi
(#2169)Black-Primer
--no-diff
to black-primer to suppress formatting changes (#2187)Changelog
21.5b0
Black
--pyi
mode if --stdin-filename
ends in .pyi
(#2169)Black-Primer
--no-diff
to black-primer to suppress formatting changes (#2187)Commits
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=21.4b2&new-version=21.5b0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
Release notes
21.8b0
Black
appdirs
dependency to platformdirs
(#2375)setuptools-scm
build-time dependency version (#2457)Blackd
Integrations
language_version
to avoid overriding default_language_version
(#2430)Changelog
21.8b0
Black
appdirs
dependency to platformdirs
(#2375)setuptools-scm
build-time dependency version (#2457)Blackd
Integrations
language_version
to avoid overriding
default_language_version
(#2430)Commits
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=21.7b0&new-version=21.8b0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
21.10b0
Black
--workers
parameter (#2514)Blackd
Black-Primer
Integrations
Changelog
21.10b0
Black
--workers
parameter (#2514)Blackd
Black-Primer
Integrations
Commits
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=21.9b0&new-version=21.10b0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
21.11b0
Black
--target-version py310
is explicitly specified (#2586)Integrations
skip_magic_trailing_comma
from pyproject.toml (#2613)21.10b0
Black
--workers
parameter (#2514)Blackd
Black-Primer
Integrations
Changelog
21.11b0
Black
--target-version py310
is explicitly specified (#2586)Integrations
skip_magic_trailing_comma
from pyproject.toml (#2613)21.10b0
Black
--workers
parameter (#2514)Blackd
Black-Primer
Integrations
Commits
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=21.9b0&new-version=21.11b0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
23.1.0
Highlights
black --preview
and give us feedback to help us set the stable style for next year.pyproject.toml
file, removing the need to set Black's target versions separately.Stable style
--skip-string-normalization
/ -S
now prevents docstring prefixes from being normalized as expected (#3168) (since 22.8.0)--skip-magic-trailing-comma
or -C
, trailing commas are stripped from subscript expressions with more than 1 element (#3209) (22.8.0)with
statements (#2926) (22.6.0)#%%
are now standardised to # %%
(#2919) (22.3.0)except
statements (#2939) (22.3.0)for
loops (#2945) (22.3.0)# fmt: off
and # fmt: on
(#3439)Preview style
if
-else
expressions (#2278)# fmt: skip
applied or there is a standalone comment between decorators (#3470)with
statements or tuples (#3473)Changelog
23.1.0
Highlights
black --preview
and give us
feedback to help us set the stable style for next year.pyproject.toml
file, removing the need to set Black's target
versions separately.Stable style
--skip-string-normalization
/ -S
now prevents docstring prefixes from being
normalized as expected (#3168) (since 22.8.0)--skip-magic-trailing-comma
or -C
, trailing commas are stripped from
subscript expressions with more than 1 element (#3209) (22.8.0)with
statements (#2926) (22.6.0)#%%
are now standardised to # %%
(#2919) (22.3.0)except
statements (#2939) (22.3.0)for
loops (#2945) (22.3.0)Commits
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)
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=22.12.0&new-version=23.1.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Commits
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)
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=blacken-docs&package-manager=pip&previous-version=1.14.0&new-version=1.15.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Changelog
Changelog
2023.03.23 -- Sassy Saffron
2022.12.07 -- Reverent Raspberry
meta
generator tag with a comment.2022.09.29 -- Quaint Quartz
2022.09.15 -- Pragmatic Pistachio
sass
.svg
in related pages nav
.Commits
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)
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=furo&package-manager=pip&previous-version=2022.12.7&new-version=2023.3.23)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Changelog
Changelog
2022.06.04.1 -- Naughty Nickel bugfix
2022.06.04 -- Naughty Nickel
basic-ng
as the base theme (from {pypi}sphinx-basic-ng
).basic-ng
's edit-this-page
component.2022.04.07 -- Magical Mauve
html_baseurl
.html_sidebars
example.2022.03.04 -- Lucent Lilac
2022.02.23 -- Keen Kobi
Commits
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 package
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=furo&package-manager=pip&previous-version=2022.4.7&new-version=2022.6.4.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Changelog
Changelog
2023.07.26 -- Vigilant Volt
2023.05.20 -- Unassuming Ultramarine
2023.03.27 -- Tasty Tangerine
2023.03.23 -- Sassy Saffron
2022.12.07 -- Reverent Raspberry
Commits
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)
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=furo&package-manager=pip&previous-version=2023.3.27&new-version=2023.7.26)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
v6.0.0
v6.0.0b2
v6.0.0b1
Changelog
Release 6.0.0 (released Dec 29, 2022)
Dependencies
Incompatible changes
jQuery
, $
, or $u
global objects, you need to update your
JavaScript to modern standards, or use the mitigation below.sphinxcontrib.jquery
to the extensions
list in conf.py
, or call
app.setup_extension("sphinxcontrib.jquery")
if you develop a Sphinx theme
or extension.jquery.js
and
underscore.js
from the Sphinx repository
_ to your static
directory,
and add the following to your layout.html
:dev-deprecated-apis
for details. Patch by Adam Turner.c_allow_pre_v3
and
c_warn_on_allowed_pre_v3
. Patch by Adam Turner.Features added
Commits
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)
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=sphinx&package-manager=pip&previous-version=5.3.0&new-version=6.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
v6.1.0
v6.0.1
v6.0.0
v6.0.0b2
v6.0.0b1
Changelog
Release 6.1.0 (released Jan 05, 2023)
Dependencies
Ruff
_ code linter.Incompatible changes
get_translation
.
This was unused and complicated other changes to sphinx.locale
.Deprecated
sphinx.util
functions:
sphinx.util.typing.stringify()
to sphinx.util.typing.stringify_annotation()
sphinx.util.xmlname_checker()
to sphinx.builders.epub3._XML_NAME_PATTERN
sphinx.util.display
:
sphinx.util.status_iterator
sphinx.util.display_chunk
sphinx.util.SkipProgressMessage
sphinx.util.progress_message
sphinx.util.http_date
:
sphinx.util.epoch_to_rfc1123
sphinx.util.rfc1123_to_epoch
sphinx.util.exceptions
:
sphinx.util.save_traceback
sphinx.util.format_exception_cut_frames
Features added
X | Y
) display conventions for typing.Optional
and typing.Optional
types within the Python domain and autodoc.Commits
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)
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=sphinx&package-manager=pip&previous-version=5.3.0&new-version=6.1.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
v6.1.1
v6.1.0
v6.0.1
v6.0.0
v6.0.0b2
v6.0.0b1
Changelog
Release 6.1.1 (released Jan 05, 2023)
Bugs fixed
util.nodes.apply_source_workaround
for literal_block
nodes
with no source information in the node or the node's parents.Release 6.1.0 (released Jan 05, 2023)
Dependencies
Ruff
_ code linter.Incompatible changes
get_translation
.
This was unused and complicated other changes to sphinx.locale
.Deprecated
sphinx.util
functions:
sphinx.util.typing.stringify()
to sphinx.util.typing.stringify_annotation()
sphinx.util.xmlname_checker()
to sphinx.builders.epub3._XML_NAME_PATTERN
sphinx.util.display
:
sphinx.util.status_iterator
sphinx.util.display_chunk
sphinx.util.SkipProgressMessage
sphinx.util.progress_message
sphinx.util.http_date
:
sphinx.util.epoch_to_rfc1123
sphinx.util.rfc1123_to_epoch
sphinx.util.exceptions
:
sphinx.util.save_traceback
Commits
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)
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=sphinx&package-manager=pip&previous-version=5.3.0&new-version=6.1.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
v7.0.1
v7.0.0
v7.0.0rc1
v6.2.1
v6.2.0
Changelog
Release 7.0.1 (released May 12, 2023)
Dependencies
Docutils 0.20
_. Patch by Adam Turner.Bugs fixed
sphinx.setup_command
following the removal of support for setuptools.
Patch by Willem Mulder.Release 7.0.0 (released Apr 29, 2023)
Incompatible changes
MecabSplitter
and
DefaultSplitter
in sphinx.search.ja
.make_old_id
functions in domain object
description classes.build_sphinx
hook in
setup.py
).sphinx.ext.napoleon.iterators
module.jsdump
format in sphinx.search
.locale
a required argument to
sphinx.util.i18n.format_date()
.sphinx.util.stemmer
module.sphinx.pycode.ast.parse()
function.sphinx.io.read_doc()
function.sphinx.util.get_matching_files()
function.sphinx.util.docutils.is_html5_writer_available()
function.env
argument to Builder
subclasses required.style
key for HTML templates.sphinx.writers.latex.LaTeXTranslator.docclasses
attribute.sphinx.builders.html.html5_ready
and
sphinx.builders.html.HTMLTranslator
attributes.Release 6.2.1 (released Apr 25, 2023)
Commits
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 removal
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=sphinx&package-manager=pip&previous-version=6.1.3&new-version=7.0.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
You can trigger a rebase of this PR by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
Sphinx 7.1.0
v7.0.1
v7.0.0
v7.0.0rc1
v6.2.1
v6.2.0
Changelog
Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
change in PyPI policy
_.Deprecated
module
, keyword
, operator
, object
, exception
,
statement
, and builtin
) in the :rst:dir:index
directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.Features added
~sphinx.application.Sphinx.require_sphinx
now allows the version
requirement to be specified as (major, minor)
.maximum_signature_line_length
and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:py:function:single-line-parameter-list
.
Patch by Thomas Louf, Adam Turner, and Jean-François B.sphinx.util.display.status_iterator
now clears the current line
with ANSI control codes, rather than overprinting with space characters.translated
attribute on translated nodes.sphinx-build -T
in parallel builds. Patch by Bénédikt Tranpy:class
and :rst:dir:py:function
directives for PEP 695 (generic classes and functions declarations) and
PEP 696 (default type parameters). Multi-line support (#11011) is enabled
for type parameters list and can be locally controlled on object description
directives, e.g., :rst:dir:py:function:single-line-type-parameter-list
.
Patch by Bénédikt Tran.linkcheck_anchors_ignore_for_url
whileCommits
e560f63
Bump to 7.1.0 final066e0fa
Add translation progress information (#11509)0882914
Target PyPI in create-release.yml21fbee5
Fix OIDC token payload1a403e4
Add informational log messaging258b0ea
Revert "Switch to using github.request
"f9c89e5
Switch to using github.request
52c7f66
Use the correct token minting URL for TestPyPI6079f28
Install twine in PyPI publish workflow3d43b9e
Fix github-script syntax in create-release.yml
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=sphinx&package-manager=pip&previous-version=6.1.3&new-version=7.1.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
Sphinx 7.1.1
Sphinx 7.1.0
v7.0.1
v7.0.0
v7.0.0rc1
v6.2.1
v6.2.0
Changelog
Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
SOURCE_DATE_EPOCH
in multi-line copyright footer.
Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
change in PyPI policy
_.Deprecated
module
, keyword
, operator
, object
, exception
,
statement
, and builtin
) in the :rst:dir:index
directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.Features added
~sphinx.application.Sphinx.require_sphinx
now allows the version
requirement to be specified as (major, minor)
.maximum_signature_line_length
and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:py:function:single-line-parameter-list
.
Patch by Thomas Louf, Adam Turner, and Jean-François B.sphinx.util.display.status_iterator
now clears the current line
with ANSI control codes, rather than overprinting with space characters.translated
attribute on translated nodes.sphinx-build -T
in parallel builds. Patch by Bénédikt TranCommits
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
"
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=sphinx&package-manager=pip&previous-version=6.1.3&new-version=7.1.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Release notes
Sphinx 7.1.2
Sphinx 7.1.1
Sphinx 7.1.0
v7.0.1
v7.0.0
v7.0.0rc1
v6.2.1
v6.2.0
Changelog
Release 7.1.2 (released Aug 02, 2023)
Bugs fixed
linkcheck_anchors
and do not spuriously report failures to validate anchors.
Patch by James Addison.Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
SOURCE_DATE_EPOCH
in multi-line copyright footer.
Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
change in PyPI policy
_.Deprecated
module
, keyword
, operator
, object
, exception
,
statement
, and builtin
) in the :rst:dir:index
directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.Features added
~sphinx.application.Sphinx.require_sphinx
now allows the version
requirement to be specified as (major, minor)
.maximum_signature_line_length
and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:py:function:single-line-parameter-list
.Commits
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 final
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=sphinx&package-manager=pip&previous-version=6.1.3&new-version=7.1.2)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Changelog
1.16.0 (2023-08-16)
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.py
, sage
, python3
, py3
, and numpy
.Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.--preview
option through to Black, to select the future style.language_version
from .pre-commit-hooks.yaml
.
This change allows default_language_version
in ``.pre-commit-config.yaml` to take precedence.PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.Commits
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)
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=blacken-docs&package-manager=pip&previous-version=1.15.0&new-version=1.16.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show Release notes
23.10.1
Highlights
Preview style
Packaging
Integrations
summary
parameter. (#3958)Documentation
23.10.0
Stable style
Preview style
Configuration
BLACK_CACHE_DIR
is set (#3937)Parser
Changelog
23.10.1
Highlights
Preview style
Packaging
Integrations
summary
parameter. (#3958)Documentation
23.10.0
Stable style
Preview style
Configuration
BLACK_CACHE_DIR
is set (#3937)Parser
type
were not accepted inside match
statements
(#3950)Commits
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)
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=23.9.1&new-version=23.10.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show Release notes
Sphinx 7.2.0
Changelog
Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
sphinx.util.md5
and sphinx.util.sha1
.
Use hashlib
instead.sphinx.testing.path
.
Use os.path
or pathlib
instead.sphinx.util.split_index_msg
and sphinx.util.split_into
.
Use sphinx.util.index_entries.split_index_msg
instead.sphinx.builders.html.Stylesheet
and sphinx.builders.html.Javascript
.
Use sphinx.application.Sphinx.add_css_file()
and sphinx.application.Sphinx.add_js_file()
instead.sphinx.builders.html.StandaloneHTMLBuilder.css_files
and
sphinx.builders.html.StandaloneHTMLBuilder.script_files
.
Use sphinx.application.Sphinx.add_css_file()
and sphinx.application.Sphinx.add_js_file()
instead.sphinx.ext.autodoc.preserve_defaults.get_function_def()
.
Patch by Bénédikt Tran.Features added
os.PathLike
types and pathlib.Path
objects
in many more places.viewcode_line_numbers
to control
whether line numbers are added to rendered source code.
Patch by Ben Krikler.:no-typesetting:
option to suppress textual output
and only create a linkable anchor.
Patch by Latosha Maltba.doctest_show_successes
option.
Patch by Trey Hunner.:no-index:
, :no-index-entry:
, and :no-contents-entry:
.debug
logging of reasons why files are detected as out of
date.
Patch by Eric Larson.Commits
da9f8a5
Bump to 7.2.0 final794324a
Declare support for Python 3.1303bceac
[bot]: Update message catalogues (#11538)aecebce
Make _resolve_toctree()
keyword-only76658c4
Fix sphinx.ext.autodoc.preserve_defaults
(#11550)4dee162
Fix layout issues in the agogo theme for smaller viewports (#11594)4ddbee4
Fix console_scripts
entry points4add50a
Remove unneeded type annotation9d8ef83
Fix test_inspect_main_noargs
ddf8a8e
Add CHANGES entry for GH-11533
Updates `blacken-docs` from 1.15.0 to 1.16.0
Changelog
1.16.0 (2023-08-16)
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.py
, sage
, python3
, py3
, and numpy
.Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.--preview
option through to Black, to select the future style.language_version
from .pre-commit-hooks.yaml
.
This change allows default_language_version
in ``.pre-commit-config.yaml` to take precedence.PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.Commits
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)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show Release notes
Sphinx 7.2.2
Sphinx 7.2.1
Sphinx 7.2.0
Changelog
Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
StateMachine.insert_input()
patch,
for when calling with keyword arguments.in
) for the :py:class:str
interface
of the asset classes (_CascadingStyleSheet
and _JavaScript
),
which several extensions relied upon.SingleFileHTMLBuilder._get_local_toctree
,
includehidden
may be passed as a string or a boolean.:noindex:
for PyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
Bugs fixed
str
interface of the asset classes
(_CascadingStyleSheet
and _JavaScript
), which several extensions relied upon.
This will be removed in Sphinx 9.Builder.add_{css,js}_file()
,
which several extensions relied upon.TocTree.get_toctree_ancestors()
,
which several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
sphinx.util.md5
and sphinx.util.sha1
.
Use hashlib
instead.sphinx.testing.path
.
Use os.path
or pathlib
instead.sphinx.util.split_index_msg
and sphinx.util.split_into
.
Use sphinx.util.index_entries.split_index_msg
instead.sphinx.builders.html.Stylesheet
and sphinx.builders.html.Javascript
.
Use sphinx.application.Sphinx.add_css_file()
Commits
ed84d63
Bump to 7.2.2 finalea4a73e
[bot]: Update message catalogues (#11612)e47846a
Fix :noindex:
for PyModule
and JSModule``b2fc47f
Add CHANGES entry for renaming the StateMachine.insert_input()
parameter0835c3e
Fix regression in SingleFileHTMLBuilder._get_local_toctree
49dc0dd
Fix asset class string interface membership testing8512855
Fix signature of docutils include_source monkeypatch (#11610)e1d9068
Bump version441a9e4
Bump to 7.2.1 finalec31853
Restore TocTree.get_toctree_ancestors()
Updates `furo` from 2023.7.26 to 2023.8.17
Changelog
Changelog
2023.08.17 -- Wonderous White
2023.07.26 -- Vigilant Volt
2023.05.20 -- Unassuming Ultramarine
2023.03.27 -- Tasty Tangerine
2023.03.23 -- Sassy Saffron
2022.12.07 -- Reverent Raspberry
Commits
Updates `blacken-docs` from 1.15.0 to 1.16.0
Changelog
1.16.0 (2023-08-16)
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.py
, sage
, python3
, py3
, and numpy
.Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.--preview
option through to Black, to select the future style.language_version
from .pre-commit-hooks.yaml
.
This change allows default_language_version
in ``.pre-commit-config.yaml` to take precedence.PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.Commits
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)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show