Sourced from sphinx's releases.
\n\n\nSphinx 7.2.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.2 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Fix the signature of the
\nStateMachine.insert_input()
patch,\nfor when calling with keyword arguments.- Fixed membership testing (
\nin
) for the :py:class:str
interface\nof the asset classes (_CascadingStyleSheet
and_JavaScript
),\nwhich several extensions relied upon.- Fixed a type error in
\nSingleFileHTMLBuilder._get_local_toctree
,\nincludehidden
may be passed as a string or a boolean.- Fix
\n:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Restored the the :py:class:
\nstr
interface of the asset classes\n(_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.\nThis will be removed in Sphinx 9.- Restored calls to
\nBuilder.add_{css,js}_file()
,\nwhich several extensions relied upon.- Restored the private API
\nTocTree.get_toctree_ancestors()
,\nwhich several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
\nDependencies
\n\nDeprecated
\n\n
\n\n- #11512: Deprecate
\nsphinx.util.md5
andsphinx.util.sha1
.\nUsehashlib
instead.- #11526: Deprecate
\nsphinx.testing.path
.\nUseos.path
orpathlib
instead.- #11528: Deprecate
\nsphinx.util.split_index_msg
andsphinx.util.split_into
.\nUsesphinx.util.index_entries.split_index_msg
instead.- Deprecate
\nsphinx.builders.html.Stylesheet
\nandsphinx.builders.html.Javascript
.\nUsesphinx.application.Sphinx.add_css_file()
... (truncated)
\ned84d63
Bump to 7.2.2 finalea4a73e
[bot]: Update message catalogues (#11612)e47846a
Fix :noindex:
for PyModule
and JSModule``b2fc47f
Add CHANGES entry for renaming the StateMachine.insert_input()
parameter0835c3e
Fix regression in SingleFileHTMLBuilder._get_local_toctree
49dc0dd
Fix asset class string interface membership testing8512855
Fix signature of docutils include_source monkeypatch (#11610)e1d9068
Bump version441a9e4
Bump to 7.2.1 finalec31853
Restore TocTree.get_toctree_ancestors()
Sourced from furo's changelog.
\n\n\nChangelog
\n\n2023.08.19 -- Xenolithic Xanadu
\n\n
\n- Fix missing search context with Sphinx 7.2, for dirhtml builds.
\n- Drop support for Python 3.7.
\n- Present configuration errors in a better format -- thanks
\n@\u200bAA-Turner
!- Bump
\nrequire_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
\n\n
\n- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n
... (truncated)
\n0766bb2
Prepare release: 2023.08.19807d73c
Update changelog364b261
Accomodate for the required data-content_root
for search0d38bc6
Simplify retrieval of pygments_dark_style
value (#699)3631ffc
Use sphinx.errors.ConfigError
(#697)d2e2448
Remove duplicate HTML builder check (#698)7b4f130
Drop Python 3.7 (#701)e322b71
Remove pointless assert (#702)ee2097a
Bump require_sphinx()
to Sphinx 6.0 (#700)c1ff10b
Back to developmentSourced from blacken-docs's changelog.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
\n\n\nSphinx 7.2.3
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.3 (released Aug 23, 2023)
\nDependencies
\n\n
\n- #11576: Require sphinxcontrib-serializinghtml 1.1.9.
\nBugs fixed
\n\n
\n- Fix regression in
\nautodoc.Documenter.parse_name()
.- Fix regression in JSON serialisation.
\n- #11543: autodoc: Support positional-only parameters in
\nclassmethod
methods\nwhenautodoc_preserve_defaults
isTrue
.- Restore support string methods on path objects.\nThis is deprecated and will be removed in Sphinx 8.\nUse :py:func
\nos.fspath
to convert :py:class:pathlib.Path
objects to strings,\nor :py:class:pathlib.Path
's methods to work with path objects.Release 7.2.2 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Fix the signature of the
\nStateMachine.insert_input()
patch,\nfor when calling with keyword arguments.- Fixed membership testing (
\nin
) for the :py:class:str
interface\nof the asset classes (_CascadingStyleSheet
and_JavaScript
),\nwhich several extensions relied upon.- Fixed a type error in
\nSingleFileHTMLBuilder._get_local_toctree
,\nincludehidden
may be passed as a string or a boolean.- Fix
\n:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Restored the the :py:class:
\nstr
interface of the asset classes\n(_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.\nThis will be removed in Sphinx 9.- Restored calls to
\nBuilder.add_{css,js}_file()
,\nwhich several extensions relied upon.- Restored the private API
\nTocTree.get_toctree_ancestors()
,\nwhich several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
\n\n
... (truncated)
\n2f6ea14
Bump to 7.2.3 final511e407
Implement bool()
for string paths494de73
Implement hash()
for string paths2986aa1
Override special methods for string paths07b87e9
Update CHANGES for 7.2.36b17dd1
Support string methods on path objects (#11619)a73fb59
Support positional-only parameters in classmethods (#11635)02cb02c
Fix invocation of python -m sphinx build
6183b6a
Require sphinxcontrib-serializinghtml 1.1.9 or later1e16f21
Fix regression in autodoc.Documenter.parse_name
(#11613)Sourced from furo's changelog.
\n\n\nChangelog
\n\n2023.08.19 -- Xenolithic Xanadu
\n\n
\n- Fix missing search context with Sphinx 7.2, for dirhtml builds.
\n- Drop support for Python 3.7.
\n- Present configuration errors in a better format -- thanks
\n@\u200bAA-Turner
!- Bump
\nrequire_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
\n\n
\n- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n
... (truncated)
\n0766bb2
Prepare release: 2023.08.19807d73c
Update changelog364b261
Accomodate for the required data-content_root
for search0d38bc6
Simplify retrieval of pygments_dark_style
value (#699)3631ffc
Use sphinx.errors.ConfigError
(#697)d2e2448
Remove duplicate HTML builder check (#698)7b4f130
Drop Python 3.7 (#701)e322b71
Remove pointless assert (#702)ee2097a
Bump require_sphinx()
to Sphinx 6.0 (#700)c1ff10b
Back to developmentSourced from blacken-docs's changelog.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
\n\n\nSphinx 7.2.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.2 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Fix the signature of the
\nStateMachine.insert_input()
patch,\nfor when calling with keyword arguments.- Fixed membership testing (
\nin
) for the :py:class:str
interface\nof the asset classes (_CascadingStyleSheet
and_JavaScript
),\nwhich several extensions relied upon.- Fixed a type error in
\nSingleFileHTMLBuilder._get_local_toctree
,\nincludehidden
may be passed as a string or a boolean.- Fix
\n:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
\nBugs fixed
\n\n
\n- Restored the the :py:class:
\nstr
interface of the asset classes\n(_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.\nThis will be removed in Sphinx 9.- Restored calls to
\nBuilder.add_{css,js}_file()
,\nwhich several extensions relied upon.- Restored the private API
\nTocTree.get_toctree_ancestors()
,\nwhich several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
\nDependencies
\n\nDeprecated
\n\n
\n\n- #11512: Deprecate
\nsphinx.util.md5
andsphinx.util.sha1
.\nUsehashlib
instead.- #11526: Deprecate
\nsphinx.testing.path
.\nUseos.path
orpathlib
instead.- #11528: Deprecate
\nsphinx.util.split_index_msg
andsphinx.util.split_into
.\nUsesphinx.util.index_entries.split_index_msg
instead.- Deprecate
\nsphinx.builders.html.Stylesheet
\nandsphinx.builders.html.Javascript
.\nUsesphinx.application.Sphinx.add_css_file()
... (truncated)
\ned84d63
Bump to 7.2.2 finalea4a73e
[bot]: Update message catalogues (#11612)e47846a
Fix :noindex:
for PyModule
and JSModule``b2fc47f
Add CHANGES entry for renaming the StateMachine.insert_input()
parameter0835c3e
Fix regression in SingleFileHTMLBuilder._get_local_toctree
49dc0dd
Fix asset class string interface membership testing8512855
Fix signature of docutils include_source monkeypatch (#11610)e1d9068
Bump version441a9e4
Bump to 7.2.1 finalec31853
Restore TocTree.get_toctree_ancestors()
Sourced from furo's changelog.
\n\n\nChangelog
\n\n2023.08.17 -- Wonderous White
\n\n
\n- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n- Remove the "indent" of API entries which have a background.
\n- Break long inline code literals.
\n2022.12.07 -- Reverent Raspberry
\n\n
\n\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n
... (truncated)
\nSourced from blacken-docs's changelog.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
\n\n\nSphinx 7.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.2.0 (released Aug 17, 2023)
\nDependencies
\n\nDeprecated
\n\n
\n- #11512: Deprecate
\nsphinx.util.md5
andsphinx.util.sha1
.\nUsehashlib
instead.- #11526: Deprecate
\nsphinx.testing.path
.\nUseos.path
orpathlib
instead.- #11528: Deprecate
\nsphinx.util.split_index_msg
andsphinx.util.split_into
.\nUsesphinx.util.index_entries.split_index_msg
instead.- Deprecate
\nsphinx.builders.html.Stylesheet
\nandsphinx.builders.html.Javascript
.\nUsesphinx.application.Sphinx.add_css_file()
\nandsphinx.application.Sphinx.add_js_file()
instead.- #11582: Deprecate
\nsphinx.builders.html.StandaloneHTMLBuilder.css_files
and\nsphinx.builders.html.StandaloneHTMLBuilder.script_files
.\nUsesphinx.application.Sphinx.add_css_file()
\nandsphinx.application.Sphinx.add_js_file()
instead.- #11459: Deprecate
\nsphinx.ext.autodoc.preserve_defaults.get_function_def()
.\nPatch by B\u00e9n\u00e9dikt Tran.Features added
\n\n
\n\n- #11526: Support
\nos.PathLike
types andpathlib.Path
objects\nin many more places.- #5474: coverage: Print summary statistics tables.\nPatch by Jorge Leitao.
\n- #6319: viewcode: Add :confval:
\nviewcode_line_numbers
to control\nwhether line numbers are added to rendered source code.\nPatch by Ben Krikler.- #9662: Add the
\n:no-typesetting:
option to suppress textual output\nand only create a linkable anchor.\nPatch by Latosha Maltba.- #11221: C++: Support domain objects in the table of contents.\nPatch by Rouslan Korneychuk.
\n- #10938: doctest: Add :confval:
\ndoctest_show_successes
option.\nPatch by Trey Hunner.- #11533: Add
\n:no-index:
,:no-index-entry:
, and:no-contents-entry:
.- #11572: Improve
\ndebug
logging of reasons why files are detected as out of\ndate.\nPatch by Eric Larson.
... (truncated)
\nda9f8a5
Bump to 7.2.0 final794324a
Declare support for Python 3.1303bceac
[bot]: Update message catalogues (#11538)aecebce
Make _resolve_toctree()
keyword-only76658c4
Fix sphinx.ext.autodoc.preserve_defaults
(#11550)4dee162
Fix layout issues in the agogo theme for smaller viewports (#11594)4ddbee4
Fix console_scripts
entry points4add50a
Remove unneeded type annotation9d8ef83
Fix test_inspect_main_noargs
ddf8a8e
Add CHANGES entry for GH-11533Sourced from blacken-docs's changelog.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from blacken-docs's changelog.
\n\n\n1.16.0 (2023-08-16)
\n\n
\n- \n
\nAllow Markdown fence options.
\nThanks to initial work from Matthew Anderson in
\nPR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.- \n
\nExpand Markdown detection to all Python language names from Pygments:
\npy
,sage
,python3
,py3
, andnumpy
.- \n
\nPreserve leading whitespace lines in reStructuredText code blocks.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.- \n
\nUse exit code 2 to indicate errors from Black, whilst exit code 1 remains for \u201cfiles have been formatted\u201d.
\nThanks to Julianus Pfeuffer for the report in
\nIssue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.- \n
\nSupport passing the
\n--preview
option through to Black, to select the future style.- \n
\nRemove
\nlanguage_version
from.pre-commit-hooks.yaml
.\nThis change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
\nPR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
\n\n\nSphinx 7.1.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.1.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.1.2 (released Aug 02, 2023)
\nBugs fixed
\n\n
\n- #11542: linkcheck: Properly respect :confval:
\nlinkcheck_anchors
\nand do not spuriously report failures to validate anchors.\nPatch by James Addison.Release 7.1.1 (released Jul 27, 2023)
\nBugs fixed
\n\n
\n- #11514: Fix
\nSOURCE_DATE_EPOCH
in multi-line copyright footer.\nPatch by B\u00e9n\u00e9dikt Tran.Release 7.1.0 (released Jul 24, 2023)
\nIncompatible changes
\n\n
\n- \n
\nReleases are no longer signed, given the
\nchange in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
\nDeprecated
\n\n
\n- #11412: Emit warnings on using a deprecated Python-specific index entry type\n(namely,
\nmodule
,keyword
,operator
,object
,exception
,\nstatement
, andbuiltin
) in the :rst:dir:index
directive, and\nset the removal version to Sphinx 9. Patch by Adam Turner.Features added
\n\n
\n\n- #11415: Add a checksum to JavaScript and CSS asset URIs included within\ngenerated HTML, using the CRC32 algorithm.
\n- :meth:
\n~sphinx.application.Sphinx.require_sphinx
now allows the version\nrequirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via\n:confval:
\nmaximum_signature_line_length
and the domain-specific variants.\nIf the length of the signature (in characters) is greater than the configured\nlimit, each parameter in the signature will be split to its own logical line.\nThis behaviour may also be controlled by options on object description\ndirectives, for example :rst:dir:py:function:single-line-parameter-list
.
... (truncated)
\n320d0b6
Bump to 7.1.2 final06c1339
Ensure that linkcheck_anchors
is properly respected (#11544)89808c6
Emend attribution for GH-11431 in CHANGES (#11547)4958d2a
Fix flake8 E231 reported linting failure4862da8
Bump versiond8d73c1
Bump to 7.1.1 finala54e630
[internationalisation] Update message catalogues8452300
Fix multi-line copyright when SOURCE_DATE_EPOCH
is set (#11524)fe08cec
bump versione560f63
Bump to 7.1.0 finalSourced from furo's changelog.
\n\n\nChangelog
\n\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n- Remove the "indent" of API entries which have a background.
\n- Break long inline code literals.
\n2022.12.07 -- Reverent Raspberry
\n\n
\n\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n- Drop support for Sphinx 4.
\n- Improve documentation about what the edit button does.
\n- Improve handling of empty-flexboxes for better print experience on Chrome.
\n- Improve styling for inline signatures.
\n
... (truncated)
\n35f5307
Prepare release: 2023.07.260a8bedc
Update changeloga92dd0c
Make _add_asset_hashes
a no-op with Sphinx 7.1f8db95b
Improve literals with inline code are handled1680dbe
Document the use of figclass
with figure
directivebeebd7e
Increase the specificity of the admonition title selector834e951
Setup uploads to Percy27bf2c0
[pre-commit.ci] pre-commit autoupdate (#672)c8b51d0
Fix how content overflow is handled80afa27
[pre-commit.ci] pre-commit autoupdate (#652)Sourced from blacken-docs's changelog.
\n\n\n1.15.0 (2023-07-09)
\n\n
\n- Drop Python 3.7 support.
\n
2e74dc4
Version 1.15.08ddb2f1
[pre-commit.ci] pre-commit autoupdate (#257)64fbca6
Drop Python 3.7 support (#256)f6a0817
[pre-commit.ci] pre-commit autoupdate (#255)cbdcb50
[pre-commit.ci] pre-commit autoupdate (#254)37fc70e
Upgrade requirements (#253)7bbe434
[pre-commit.ci] pre-commit autoupdate (#250)Sourced from sphinx's releases.
\n\n\nSphinx 7.1.2
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.1.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.1.2 (released Aug 02, 2023)
\nBugs fixed
\n\n
\n- #11542: linkcheck: Properly respect :confval:
\nlinkcheck_anchors
\nand do not spuriously report failures to validate anchors.\nPatch by James Addison.Release 7.1.1 (released Jul 27, 2023)
\nBugs fixed
\n\n
\n- #11514: Fix
\nSOURCE_DATE_EPOCH
in multi-line copyright footer.\nPatch by B\u00e9n\u00e9dikt Tran.Release 7.1.0 (released Jul 24, 2023)
\nIncompatible changes
\n\n
\n- \n
\nReleases are no longer signed, given the
\nchange in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
\nDeprecated
\n\n
\n- #11412: Emit warnings on using a deprecated Python-specific index entry type\n(namely,
\nmodule
,keyword
,operator
,object
,exception
,\nstatement
, andbuiltin
) in the :rst:dir:index
directive, and\nset the removal version to Sphinx 9. Patch by Adam Turner.Features added
\n\n
\n\n- #11415: Add a checksum to JavaScript and CSS asset URIs included within\ngenerated HTML, using the CRC32 algorithm.
\n- :meth:
\n~sphinx.application.Sphinx.require_sphinx
now allows the version\nrequirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via\n:confval:
\nmaximum_signature_line_length
and the domain-specific variants.\nIf the length of the signature (in characters) is greater than the configured\nlimit, each parameter in the signature will be split to its own logical line.\nThis behaviour may also be controlled by options on object description\ndirectives, for example :rst:dir:py:function:single-line-parameter-list
.
... (truncated)
\n320d0b6
Bump to 7.1.2 final06c1339
Ensure that linkcheck_anchors
is properly respected (#11544)89808c6
Emend attribution for GH-11431 in CHANGES (#11547)4958d2a
Fix flake8 E231 reported linting failure4862da8
Bump versiond8d73c1
Bump to 7.1.1 finala54e630
[internationalisation] Update message catalogues8452300
Fix multi-line copyright when SOURCE_DATE_EPOCH
is set (#11524)fe08cec
bump versione560f63
Bump to 7.1.0 finalSourced from furo's changelog.
\n\n\nChangelog
\n\n2023.07.26 -- Vigilant Volt
\n\n
\n- Fix compatiblity with Sphinx 7.1.
\n- Improve how content overflow is handled.
\n- Improve how literal blocks containing inline code are handled.
\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n- Remove the "indent" of API entries which have a background.
\n- Break long inline code literals.
\n2022.12.07 -- Reverent Raspberry
\n\n
\n\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n- Drop support for Sphinx 4.
\n- Improve documentation about what the edit button does.
\n- Improve handling of empty-flexboxes for better print experience on Chrome.
\n- Improve styling for inline signatures.
\n
... (truncated)
\n35f5307
Prepare release: 2023.07.260a8bedc
Update changeloga92dd0c
Make _add_asset_hashes
a no-op with Sphinx 7.1f8db95b
Improve literals with inline code are handled1680dbe
Document the use of figclass
with figure
directivebeebd7e
Increase the specificity of the admonition title selector834e951
Setup uploads to Percy27bf2c0
[pre-commit.ci] pre-commit autoupdate (#672)c8b51d0
Fix how content overflow is handled80afa27
[pre-commit.ci] pre-commit autoupdate (#652)Sourced from blacken-docs's changelog.
\n\n\n1.15.0 (2023-07-09)
\n\n
\n- Drop Python 3.7 support.
\n
2e74dc4
Version 1.15.08ddb2f1
[pre-commit.ci] pre-commit autoupdate (#257)64fbca6
Drop Python 3.7 support (#256)f6a0817
[pre-commit.ci] pre-commit autoupdate (#255)cbdcb50
[pre-commit.ci] pre-commit autoupdate (#254)37fc70e
Upgrade requirements (#253)7bbe434
[pre-commit.ci] pre-commit autoupdate (#250)Sourced from sphinx's releases.
\n\n\nSphinx 7.1.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nSphinx 7.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.1.1 (released Jul 27, 2023)
\nBugs fixed
\n\n
\n- #11514: Fix
\nSOURCE_DATE_EPOCH
in multi-line copyright footer.\nPatch by B\u00e9n\u00e9dikt Tran.Release 7.1.0 (released Jul 24, 2023)
\nIncompatible changes
\n\n
\n- \n
\nReleases are no longer signed, given the
\nchange in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
\nDeprecated
\n\n
\n- #11412: Emit warnings on using a deprecated Python-specific index entry type\n(namely,
\nmodule
,keyword
,operator
,object
,exception
,\nstatement
, andbuiltin
) in the :rst:dir:index
directive, and\nset the removal version to Sphinx 9. Patch by Adam Turner.Features added
\n\n
\n\n- #11415: Add a checksum to JavaScript and CSS asset URIs included within\ngenerated HTML, using the CRC32 algorithm.
\n- :meth:
\n~sphinx.application.Sphinx.require_sphinx
now allows the version\nrequirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via\n:confval:
\nmaximum_signature_line_length
and the domain-specific variants.\nIf the length of the signature (in characters) is greater than the configured\nlimit, each parameter in the signature will be split to its own logical line.\nThis behaviour may also be controlled by options on object description\ndirectives, for example :rst:dir:py:function:single-line-parameter-list
.\nPatch by Thomas Louf, Adam Turner, and Jean-Fran\u00e7ois B.- #10983: Support for multiline copyright statements in the footer block.\nPatch by Stefanie Molin
\n- \n
sphinx.util.display.status_iterator
now clears the current line\nwith ANSI control codes, rather than overprinting with space characters.- #11431: linkcheck: Treat SSL failures as broken links.\nPatch by B\u00e9n\u00e9dikt Tran
\n- #11157: Keep the
\ntranslated
attribute on translated nodes.- #11451: Improve the traceback displayed when using :option:
\nsphinx-build -T
\nin parallel builds. Patch by B\u00e9n\u00e9dikt Tran
... (truncated)
\nd8d73c1
Bump to 7.1.1 finala54e630
[internationalisation] Update message catalogues8452300
Fix multi-line copyright when SOURCE_DATE_EPOCH
is set (#11524)fe08cec
bump versione560f63
Bump to 7.1.0 final066e0fa
Add translation progress information (#11509)0882914
Target PyPI in create-release.yml21fbee5
Fix OIDC token payload1a403e4
Add informational log messaging258b0ea
Revert "Switch to using github.request
"Sourced from sphinx's releases.
\n\n\nSphinx 7.1.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.1.0 (released Jul 24, 2023)
\nIncompatible changes
\n\n
\n- \n
\nReleases are no longer signed, given the
\nchange in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
\nDeprecated
\n\n
\n- #11412: Emit warnings on using a deprecated Python-specific index entry type\n(namely,
\nmodule
,keyword
,operator
,object
,exception
,\nstatement
, andbuiltin
) in the :rst:dir:index
directive, and\nset the removal version to Sphinx 9. Patch by Adam Turner.Features added
\n\n
\n\n- #11415: Add a checksum to JavaScript and CSS asset URIs included within\ngenerated HTML, using the CRC32 algorithm.
\n- :meth:
\n~sphinx.application.Sphinx.require_sphinx
now allows the version\nrequirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via\n:confval:
\nmaximum_signature_line_length
and the domain-specific variants.\nIf the length of the signature (in characters) is greater than the configured\nlimit, each parameter in the signature will be split to its own logical line.\nThis behaviour may also be controlled by options on object description\ndirectives, for example :rst:dir:py:function:single-line-parameter-list
.\nPatch by Thomas Louf, Adam Turner, and Jean-Fran\u00e7ois B.- #10983: Support for multiline copyright statements in the footer block.\nPatch by Stefanie Molin
\n- \n
sphinx.util.display.status_iterator
now clears the current line\nwith ANSI control codes, rather than overprinting with space characters.- #11431: linkcheck: Treat SSL failures as broken links.\nPatch by B\u00e9n\u00e9dikt Tran
\n- #11157: Keep the
\ntranslated
attribute on translated nodes.- #11451: Improve the traceback displayed when using :option:
\nsphinx-build -T
\nin parallel builds. Patch by B\u00e9n\u00e9dikt Tran- #11324: linkcheck: Use session-basd HTTP requests.
\n- #11438: Add support for the :rst:dir:
\npy:class
and :rst:dir:py:function
\ndirectives for PEP 695 (generic classes and functions declarations) and\nPEP 696 (default type parameters). Multi-line support (#11011) is enabled\nfor type parameters list and can be locally controlled on object description\ndirectives, e.g., :rst:dir:py:function:single-line-type-parameter-list
.\nPatch by B\u00e9n\u00e9dikt Tran.- #11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis\nvia :confval:
\nlinkcheck_anchors_ignore_for_url
while
... (truncated)
\ne560f63
Bump to 7.1.0 final066e0fa
Add translation progress information (#11509)0882914
Target PyPI in create-release.yml21fbee5
Fix OIDC token payload1a403e4
Add informational log messaging258b0ea
Revert "Switch to using github.request
"f9c89e5
Switch to using github.request
52c7f66
Use the correct token minting URL for TestPyPI6079f28
Install twine in PyPI publish workflow3d43b9e
Fix github-script syntax in create-release.ymlSourced from furo's changelog.
\n\n\nChangelog
\n\n2023.05.20 -- Unassuming Ultramarine
\n\n
\n- \u2728 Add support for Sphinx 7.
\n- Drop support for Sphinx 5.
\n- Improve the screen-reader label for sidebar collapse.
\n- Make it easier to create derived themes from Furo.
\n- Bump all JS dependencies (NodeJS and npm packages).
\n2023.03.27 -- Tasty Tangerine
\n\n
\n- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
\n- Add missing class to Font Awesome examples
\n2023.03.23 -- Sassy Saffron
\n\n
\n- Update Python version classifiers.
\n- Increase the icon size in mobile header.
\n- Increase admonition title bg opacity.
\n- Change the default API background to transparent.
\n- Transition the API background change.
\n- Remove the "indent" of API entries which have a background.
\n- Break long inline code literals.
\n2022.12.07 -- Reverent Raspberry
\n\n
\n- \u2728 Add support for Sphinx 6.
\n- \u2728 Improve footnote presentation with docutils 0.18+.
\n- Drop support for Sphinx 4.
\n- Improve documentation about what the edit button does.
\n- Improve handling of empty-flexboxes for better print experience on Chrome.
\n- Improve styling for inline signatures.
\n- Replace the
\nmeta
generator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
\n2022.09.29 -- Quaint Quartz
\n\n
\n\n- Add ability to set arbitrary URLs for edit button.
\n
... (truncated)
\nd2c9ca8
Prepare release: 2023.05.20662d21b
Update changelog591780b
Bump compatible Sphinx versionc2e7837
Bump NodeJS and package versionsdd85574
Use the reference HtmlFormatter class defined on PygmentsBridge. (#657)6bff419
Fix broken link (#654)e7f732e
Improve the screen-reader label for sidebar collapse48c0bf2
Drop the check for the theme name1b17d81
[pre-commit.ci] pre-commit autoupdate (#646)4904fd5
Remove Python 3.8 constraint from Black pre-commit config (#647)Sourced from sphinx's releases.
\n\n\nv7.0.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv7.0.0rc1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.1
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\nv6.2.0
\nChangelog: https://www.sphinx-doc.org/en/master/changes.html
\n
Sourced from sphinx's changelog.
\n\n\nRelease 7.0.1 (released May 12, 2023)
\nDependencies
\n\n
\n- #11411: Support
\nDocutils 0.20
_. Patch by Adam Turner... _Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04
\nBugs fixed
\n\n
\n- #11418: Clean up remaining references to
\nsphinx.setup_command
\nfollowing the removal of support for setuptools.\nPatch by Willem Mulder.Release 7.0.0 (released Apr 29, 2023)
\nIncompatible changes
\n\n
\n- #11359: Remove long-deprecated aliases for
\nMecabSplitter
and\nDefaultSplitter
insphinx.search.ja
.- #11360: Remove deprecated
\nmake_old_id
functions in domain object\ndescription classes.- #11363: Remove the Setuptools integration (
\nbuild_sphinx
hook in\nsetup.py
).- #11364: Remove deprecated
\nsphinx.ext.napoleon.iterators
module.- #11365: Remove support for the
\njsdump
format insphinx.search
.- #11366: Make
\nlocale
a required argument to\nsphinx.util.i18n.format_date()
.- #11370: Remove deprecated
\nsphinx.util.stemmer
module.- #11371: Remove deprecated
\nsphinx.pycode.ast.parse()
function.- #11372: Remove deprecated
\nsphinx.io.read_doc()
function.- #11373: Removed deprecated
\nsphinx.util.get_matching_files()
function.- #11378: Remove deprecated
\nsphinx.util.docutils.is_html5_writer_available()
\nfunction.- #11379: Make the
\nenv
argument toBuilder
subclasses required.- #11380: autosummary: Always emit grouped import exceptions.
\n- #11381: Remove deprecated
\nstyle
key for HTML templates.- #11382: Remove deprecated
\nsphinx.writers.latex.LaTeXTranslator.docclasses
\nattribute.- #11383: Remove deprecated
\nsphinx.builders.html.html5_ready
and\nsphinx.builders.html.HTMLTranslator
attributes.- #11385: Remove support for HTML 4 output.
\nRelease 6.2.1 (released Apr 25, 2023)
\n\n
... (truncated)
\nd48cc78
Bump to 7.0.1 finalde6b18a
Remove remaining references to the setuptools integration (#11418)db54618
Support Docutils 0.20 (#11411)8942a1d
Test with Docutils 0.20c9d0933
linkcheck: Use context managers for HTTP requests (#11318)2b1c106
Update documentation workflowba74082
Change concurrency groups for GitHub workflowsb546879
Bump versiond568b2f
Bump to 7.0.0 finalff79edf
Remove jsdump
references post removal{{ display.snippet|safe }}
\r\n```\r\n\r\nUnfortunately, rendering fails with a message 'urls is undefined'.\r\n\r\nThe same happens if I'm trying to build a row URL manually, using filters like `quote_plus` (as my keys are URLs).\r\n\r\nAny hints?\r\n\r\nThanks!", "repo": {"value": 197431109, "label": "dogsheep-beta"}, "type": "issue", "active_lock_reason": null, "performed_via_github_app": null, "reactions": "{\"url\": \"https://api.github.com/repos/dogsheep/dogsheep-beta/issues/37/reactions\", \"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "draft": null, "state_reason": "completed"} {"id": 1816997390, "node_id": "I_kwDOCGYnMM5sTS4O", "number": 576, "title": "Backfill the release notes prior to 0.4", "user": {"value": 9599, "label": "simonw"}, "state": "closed", "locked": 0, "assignee": null, "milestone": null, "comments": 2, "created_at": "2023-07-23T05:41:42Z", "updated_at": "2023-07-23T05:49:51Z", "closed_at": "2023-07-23T05:48:21Z", "author_association": "OWNER", "pull_request": null, "body": "Currently the changelog starts at 0.4:\r\n\r\nhttps://sqlite-utils.datasette.io/en/3.34/changelog.html#id115\r\n\r\nI want the other releases - according to https://pypi.org/project/sqlite-utils/#history there are three missing:\r\n\r\n\r\n", "repo": {"value": 140912432, "label": "sqlite-utils"}, "type": "issue", "active_lock_reason": null, "performed_via_github_app": null, "reactions": "{\"url\": \"https://api.github.com/repos/simonw/sqlite-utils/issues/576/reactions\", \"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "draft": null, "state_reason": "completed"} {"id": 1816919568, "node_id": "I_kwDOCGYnMM5sS_4Q", "number": 575, "title": "Python API ability to opt-out of connection plugins", "user": {"value": 9599, "label": "simonw"}, "state": "closed", "locked": 0, "assignee": null, "milestone": null, "comments": 2, "created_at": "2023-07-22T23:01:13Z", "updated_at": "2023-07-22T23:17:22Z", "closed_at": "2023-07-22T23:08:22Z", "author_association": "OWNER", "pull_request": null, "body": "Plugins affecting the CLI by default makes sense to me.\r\n\r\nI'm less confident about them _always_ affecting users of the Python API.\r\n\r\nI'm going to have them apply by default, but I'm going to add a mechanism to opt-out on an individual database basis. Basically this:\r\n\r\n```python\r\nfrom sqlite_utils import Database\r\ndb = Database(memory=True, execute_plugins=False)\r\n# Anything using db from here on will not execute plugins\r\n```\r\ncc @asg017 \r\n\r\nRefs:\r\n- #567 \r\n- #574 ", "repo": {"value": 140912432, "label": "sqlite-utils"}, "type": "issue", "active_lock_reason": null, "performed_via_github_app": null, "reactions": "{\"url\": \"https://api.github.com/repos/simonw/sqlite-utils/issues/575/reactions\", \"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "draft": null, "state_reason": "completed"} {"id": 1816918185, "node_id": "I_kwDOCGYnMM5sS_ip", "number": 574, "title": "`prepare_connection()` plugin hook", "user": {"value": 9599, "label": "simonw"}, "state": "closed", "locked": 0, "assignee": null, "milestone": null, "comments": 3, "created_at": "2023-07-22T22:52:47Z", "updated_at": "2023-07-22T23:13:14Z", "closed_at": "2023-07-22T22:59:10Z", "author_association": "OWNER", "pull_request": null, "body": "> Splitting off an issue for `prepare_connection()` since Alex got the PR in seconds before I shipped 3.34!\r\n\r\n_Originally posted by @simonw in https://github.com/simonw/sqlite-utils/issues/567#issuecomment-1646686424_\r\n ", "repo": {"value": 140912432, "label": "sqlite-utils"}, "type": "issue", "active_lock_reason": null, "performed_via_github_app": null, "reactions": "{\"url\": \"https://api.github.com/repos/simonw/sqlite-utils/issues/574/reactions\", \"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "draft": null, "state_reason": "completed"} {"id": 1801394744, "node_id": "I_kwDOCGYnMM5rXxo4", "number": 567, "title": "Plugin system", "user": {"value": 15178711, "label": "asg017"}, "state": "closed", "locked": 0, "assignee": null, "milestone": null, "comments": 9, "created_at": "2023-07-12T17:02:14Z", "updated_at": "2023-07-22T22:59:37Z", "closed_at": "2023-07-22T22:59:36Z", "author_association": "CONTRIBUTOR", "pull_request": null, "body": "I'd like there to be a plugin system for sqlite-utils, similar to the datasette/llm plugins. I'd like to make plugins that would do things like:\r\n\r\n- Register SQLite extensions for more SQL functions + virtual tables\r\n- Register new subcommands\r\n- Different input file formats for `sqlite-utils memory`\r\n- Different output file formats (in addition to `--csv` `--tsv` `--nl` etc.\r\n\r\nA few real-world use-cases of plugins I'd like to see in sqlite-utils:\r\n\r\n- Register many of my sqlite extensions in sqlite-utils (`sqlite-http`, `sqlite-lines`, `sqlite-regex`, etc.)\r\n- New subcommands to work with `sqlite-vss` vector tables\r\n- Input/ouput Parquet/Avro/Arrow IPC files with `sqlite-arrow`", "repo": {"value": 140912432, "label": "sqlite-utils"}, "type": "issue", "active_lock_reason": null, "performed_via_github_app": null, "reactions": "{\"url\": \"https://api.github.com/repos/simonw/sqlite-utils/issues/567/reactions\", \"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "draft": null, "state_reason": "completed"} {"id": 1816917522, "node_id": "PR_kwDOCGYnMM5WJ6Jm", "number": 573, "title": "feat: Implement a prepare_connection plugin hook", "user": {"value": 15178711, "label": "asg017"}, "state": "closed", "locked": 0, "assignee": null, "milestone": null, "comments": 4, "created_at": "2023-07-22T22:48:44Z", "updated_at": "2023-07-22T22:59:09Z", "closed_at": "2023-07-22T22:59:09Z", "author_association": "CONTRIBUTOR", "pull_request": "simonw/sqlite-utils/pulls/573", "body": "Just like the [Datasette prepare_connection hook](https://docs.datasette.io/en/stable/plugin_hooks.html#prepare-connection-conn-database-datasette), this PR adds a similar hook for the `sqlite-utils` plugin system. \r\n\r\nThe sole argument is `conn`, since I don't believe a `database` or `datasette` argument would be relevant here. \r\n\r\nI want to do this so I can release `sqlite-utils` plugins for my [SQLite extensions](https://github.com/asg017/sqlite-ecosystem), similar to the Datasette plugins I've release for them. \r\n\r\nAn example plugin: https://gist.github.com/asg017/d7cdf0d56e2be87efda28cebee27fa3c\r\n\r\n```bash\r\n$ sqlite-utils install https://gist.github.com/asg017/d7cdf0d56e2be87efda28cebee27fa3c/archive/5f5ad549a40860787629c69ca120a08c32519e99.zip\r\n\r\n$ sqlite-utils memory 'select hello(\"alex\") as response'\r\n[{\"response\": \"Hello, alex!\"}]\r\n```\r\nRefs:\r\n- #574 \r\n\r\n\r\n----\r\n:books: Documentation preview :books:: https://sqlite-utils--573.org.readthedocs.build/en/573/\r\n\r\n", "repo": {"value": 140912432, "label": "sqlite-utils"}, "type": "pull", "active_lock_reason": null, "performed_via_github_app": null, "reactions": "{\"url\": \"https://api.github.com/repos/simonw/sqlite-utils/issues/573/reactions\", \"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "draft": 0, "state_reason": null} {"id": 1816876211, "node_id": "I_kwDOCGYnMM5sS1Sz", "number": 571, "title": "`.transform(keep_table=...)` option", "user": {"value": 9599, "label": "simonw"}, "state": "closed", "locked": 0, "assignee": null, "milestone": null, "comments": 1, "created_at": "2023-07-22T19:49:29Z", "updated_at": "2023-07-22T22:32:18Z", "closed_at": "2023-07-22T22:32:18Z", "author_association": "OWNER", "pull_request": null, "body": ">> Also need a design for an option for the `.transform()` method to indicate that the new table should be created with a new name without dropping the old one.\r\n>\r\n> I think `keep_table=\"name_of_table\"` is good for this.\r\n\r\n_Originally posted by @simonw in https://github.com/simonw/sqlite-utils/issues/565#issuecomment-1646657324_\r\n ", "repo": {"value": 140912432, "label": "sqlite-utils"}, "type": "issue", "active_lock_reason": null, "performed_via_github_app": null, "reactions": "{\"url\": \"https://api.github.com/repos/simonw/sqlite-utils/issues/571/reactions\", \"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "draft": null, "state_reason": "completed"} {"id": 1816877910, "node_id": "I_kwDOCGYnMM5sS1tW", "number": 572, "title": "Don't test Python 3.7 against textual", "user": {"value": 9599, "label": "simonw"}, "state": "closed", "locked": 0, "assignee": null, "milestone": null, "comments": 2, "created_at": "2023-07-22T19:57:03Z", "updated_at": "2023-07-22T22:16:50Z", "closed_at": "2023-07-22T22:16:50Z", "author_association": "OWNER", "pull_request": null, "body": "Spotted this in the GitHub Actions logs:\r\n\r\n![IMG_5046](https://github.com/simonw/sqlite-utils/assets/9599/81fb1093-cd8a-4019-a612-2e49b500c933)\r\n", "repo": {"value": 140912432, "label": "sqlite-utils"}, "type": "issue", "active_lock_reason": null, "performed_via_github_app": null, "reactions": "{\"url\": \"https://api.github.com/repos/simonw/sqlite-utils/issues/572/reactions\", \"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "draft": null, "state_reason": "completed"} {"id": 1786243905, "node_id": "I_kwDOCGYnMM5qd-tB", "number": 564, "title": "Document that running `db.transform()` tidies up the schema indentation", "user": {"value": 9599, "label": "simonw"}, "state": "closed", "locked": 0, "assignee": null, "milestone": null, "comments": 0, "created_at": "2023-07-03T13:59:28Z", "updated_at": "2023-07-22T22:15:34Z", "closed_at": "2023-07-22T22:15:34Z", "author_association": "OWNER", "pull_request": null, "body": "> ... and it turns out running `.transform()` with no arguments still fixes the format of the schema!\r\n\r\n```pycon\r\n>>> db[\"log\"].add_column(\"foo\", str)\r\n