Bump the sphinx group with 5 updates #280

dependabot · 2024-06-21T09:31:00Z

Bumps the sphinx group with 5 updates:

Package	From	To
sphinx	`7.2.6`	`7.3.7`
sphinx-autobuild	`2024.2.4`	`2024.4.16`
sphinx-gallery	`0.15.0`	`0.16.0`
sphinx-notfound-page	`1.0.0`	`1.0.2`
sphinx-design	`0.5.0`	`0.6.0`

Updates sphinx from 7.2.6 to 7.3.7

Release notes

Sourced from sphinx's releases.

Sphinx 7.3.7

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.3.6

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.3.5

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.3.4

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.3.3

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.3.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.3.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.3.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 7.3.7 (released Apr 19, 2024)

Bugs fixed

#12299: Defer loading themes defined via entry points until their explicit use by the user or a child theme. Patch by Adam Turner.

#12305: Return the default value for theme.get_config() with an unsupported theme configuration section. Patch by Adam Turner.

Release 7.3.6 (released Apr 17, 2024)

Bugs fixed

#12295: Re-export all AST types in the C and C++ domains. Patch by Adam Turner.

#12295: Re-export various objects from sphinx.domains.python._annotations in sphinx.domains.python. Patch by Jacob Chesslo and Adam Turner.

Release 7.3.5 (released Apr 17, 2024)

Bugs fixed

#12295: Re-export various objects from sphinx.domains.python._object in sphinx.domains.python. Patch by Jacob Chesslo and Adam Turner.

Release 7.3.4 (released Apr 17, 2024)

Bugs fixed

Handle cases when Any is not an instance of type. Patch by Adam Turner.

Release 7.3.3 (released Apr 17, 2024)

Bugs fixed

... (truncated)

Commits

de4ac2f Bump to 7.3.7 final
4a0c9dd Return the default value for unsupported theme configuration sections
62c3bad Re-export py_sig_re from the Python domain
3bcc669 Defer loading entry-point themes until needed
fa4563f Bump version
630b4fb Bump to 7.3.6 final
740b964 fixup! Elaborate a little more in the warning message for config.cache
141f3ec Elaborate a little more in the warning message for config.cache
af27188 Add config.cache to the list of warning types
be2b083 Re-export more names in sphinx.domains.python (#12297)
Additional commits viewable in compare view

Updates sphinx-autobuild from 2024.2.4 to 2024.4.16

Release notes

Sourced from sphinx-autobuild's releases.

Release 2024.04.16

2024.04.16

Release 2024.04.13

2024.04.13

Changelog

Sourced from sphinx-autobuild's changelog.

Changelog

unreleased

Fix support for Python 3.9.

2024.04.16 - 2024-04-16

Add a missing dependency on watchfiles.

Adopt Ruff in place of flake8 and black.

2024.04.13 - 2024-04-13

Drop python-livereload.

Add starlette and uvicorn as dependencies.

Implement hot reloading via websockets.

Run Sphinx rebuilds in an asynchronous executor.

2024.02.04 - 2024-02-04

Declare support for Python 3.9, 3.10, 3.11, and 3.12

Drop support for Python 3.8 and earlier

Allow passing relative paths to --ignore

Support all valid sphinx-build options (except Make-mode)

Fix path issues on Windows

Differentiate pre-build command failures from Sphinx failures

2021.03.14 - 2021-03-14

Change output handling for subprocesses.

Present helpful error message when the subprocesses fail.

Skip the main sphinx build, if pre-build commands fail.

2020.09.01 - 2020-09-01

Adopt Calendar Versioning.

Modernize codebase and require Python 3.6+.

Directly depend on sphinx.

Rewritten documentation.

Invoke sphinx via {sys.executable} -m sphinx instead of sphinx-build.

Trim dependencies down to only livereload and sphinx.

Drop custom adapter for watchdog.

Drop --poll flag.

... (truncated)

Commits

1d432fe Release 2024.04.16
48a778c Adopt Ruff
781815a Sort dependencies
9232794 Remove unused coverage settings
ecca45c Update pre-commit tool versions
a3c4959 Add watchfiles as a dependency (#152)
bf330a4 Release 2024.04.13
f17b2ab Allow floating point --delay values
fda9582 Run change_callback in an asynchronous executor
49af6e1 Correct the help output in README.rst
Additional commits viewable in compare view

Updates sphinx-gallery from 0.15.0 to 0.16.0

Release notes

Sourced from sphinx-gallery's releases.

Release v0.16.0

Sphinx 7.3.0 and above changed caching and serialization checks. Now instead of passing instantiated classes like ResetArgv(), classes like FileNameSortKey, or callables like notebook_modification_function in sphinx_gallery_conf, you should pass fully qualified name strings to classes or callables. If you change to using name strings, you can simply use a function as the use of classes to ensure a stable __repr__ would be redundant.

See importing_callables for details.

Implemented enhancements:

ENH: Allow plain list as subsection_order and support a wildcard #1295 (timhoffm)

[ENH] Minigallery can take arbitrary files/glob patterns as input #1226 (story645)

Fixed bugs:

BUG: Fix serialization with Sphinx 7.3 #1289 (larsoner)

ENH: minigallery_sort_order on full path #1253 (story645)

BUG: UnicodeDecodeError in recommender #1244 (Charlie-XIAO)

Documentation

DOC Update FFMpeg note in conf animation docs #1292 (lucyleeow)

readme: adding quickstart section #1291 (Borda)

readme: add link to docs #1288 (Borda)

DOC Clarify sub level example gallery #1281 (lucyleeow)

DOC Mention image_srcset config in scraper section in advanced.rst #1280 (lucyleeow)

BUG: Fix errors in example usage of ignore_repr_types and reset_argv #1275 (speth)

DOC Use 'nested_sections' True for docs #1263 (lucyleeow)

fix: Missing full stop in download message #1255 (AlejandroFernandezLuces)

Add HyperSpy and kikuchipy to 'who uses' #1247 (jlaehne)

DOC: Fix formatting in contribute.rst #1237 (StefRe)

Project maintenance

[pre-commit.ci] pre-commit autoupdate #1294 (pre-commit-ci[bot])

Fix typo in test_fileno #1287 (lucyleeow)

[pre-commit.ci] pre-commit autoupdate #1284 (pre-commit-ci[bot])

[pre-commit.ci] pre-commit autoupdate #1279 (pre-commit-ci[bot])

Remove leftover config checking of image_srcset #1278 (lucyleeow)

[pre-commit.ci] pre-commit autoupdate #1277 (pre-commit-ci[bot])

[pre-commit.ci] pre-commit autoupdate #1273 (pre-commit-ci[bot])

[pre-commit.ci] pre-commit autoupdate #1272 (pre-commit-ci[bot])

More informative title for 'check label' CI workflow #1271 (lucyleeow)

pyproject: cleaning pytest config #1269 (Borda)

allow call script as pkg entry #1268 (Borda)

refactor: migrate to pyproject.toml #1267 (Borda)

lint: enable sphinx-lint for Sphinx extension #1266 (Borda)

ci: associate install.sh with used job #1265 (Borda)

... (truncated)

Commits

f87e6d3 MAINT version 0.16 (#1296)
2120054 ENH: Allow plain list as subsection_order and support a wildcard (#1295)
f0e716e BUG: Fix serialization with Sphinx 7.3 (#1289)
0b243bf [pre-commit.ci] pre-commit autoupdate (#1294)
0790260 readme: adding quickstart section (#1291)
8af7edb DOC Update FFMpeg note in conf animation docs (#1292)
ebe9388 readme: add link to docs (#1288)
594bd90 Fix typo in test_fileno (#1287)
e22fc20 [pre-commit.ci] pre-commit autoupdate (#1284)
6faca83 [pre-commit.ci] pre-commit autoupdate (#1279)
Additional commits viewable in compare view

Updates sphinx-notfound-page from 1.0.0 to 1.0.2

Changelog

Sourced from sphinx-notfound-page's changelog.

Version 1.0.2

:Date: May 23, 2024

Add tests for Python 3.12

Remove warning about unclosed files

Allow str and None types on notfound_urls_prefix

Run pyupgrade and ruff on the codebase

Version 1.0.1

:Date: May 21, 2024

Do not create 404 page for embedded

Small documentation improvements

Commits

bf8ef76 Release 1.0.2
3032721 fix: Set proper notfound_urls_prefix option types (#233)
bbc8127 fix(tests): resource warnings about unclosed file (#232)
68fe9e6 Filter all code over pyupgrade --py38-plus and ruff (#235)
c05f361 test python 3.12 (#237)
3616f22 Release 1.0.1
19cc822 do not create 404 page for embedded (e.g. ePub) (#231)
cbbdc8e Fix spacing in docs (#228)
00ed1a1 Do not hardcode CSS/JS checksums (#226)
9d1af35 Fix quotes (#223)
Additional commits viewable in compare view

Updates sphinx-design from 0.5.0 to 0.6.0

Release notes

Sourced from sphinx-design's releases.

v0.6.0

What's Changed

Dependencies

⬆️ Python v3.9-3.12 by @chrisjsewell in executablebooks/sphinx-design#186

⬆️ Octicon icons to v19.8.0 by @ffvpor in executablebooks/sphinx-design#171

New

✨ Create custom directives

You can use the sd_custom_directives configuration option in your conf.py to add custom directives, with default option values:
sd_custom_directives = {
  "dropdown-syntax": {
    "inherit": "dropdown",
    "argument": "Syntax",
    "options": {
      "color": "primary",
      "icon": "code",
    },
  }
}
The key is the new directive name to add, and the value is a dictionary with the following keys:

inherit: The directive to inherit from (e.g. dropdown)

argument: The default argument (optional, only for directives that take a single argument)

options: A dictionary of default options for the directive (optional)

by @chrisjsewell in executablebooks/sphinx-design#194

✨ sync tabs by URL query parameters

Synchronised tabs can now be selected by adding a query parameter to the URL, for that sync-group, such as ?code=python for
.. tab-set-code::
.. literalinclude:: snippet.py
    :language: python
.. literalinclude:: snippet.js
:language: javascript
The last selected tab key, per group, is also persisted SessionStorage

... (truncated)

Changelog

Sourced from sphinx-design's changelog.

0.6.0 - 2024-05-23

Dependencies

⬆️ Python v3.9-3.12 by {user}chrisjsewell in {pr}186

⬆️ Octicon icons to v19.8.0 by {user}ffvpor in {pr}171

New

✨ Create custom directives

You can use the sd_custom_directives configuration option in your conf.py to add custom directives, with default option values:
sd_custom_directives = {
  "dropdown-syntax": {
    "inherit": "dropdown",
    "argument": "Syntax",
    "options": {
      "color": "primary",
      "icon": "code",
    },
  }
}
The key is the new directive name to add, and the value is a dictionary with the following keys:

inherit: The directive to inherit from (e.g. dropdown)

argument: The default argument (optional, only for directives that take a single argument)

options: A dictionary of default options for the directive (optional)

by {user}chrisjsewell in {pr}194

✨ sync tabs by URL query parameters

Synchronised tabs can now be selected by adding a query parameter to the URL, for that sync-group, such as ?code=python for
.. tab-set-code::
.. literalinclude:: snippet.py
    :language: python
.. literalinclude:: snippet.js
:language: javascript
The last selected tab key, per group, is also persisted to SessionStorage

... (truncated)

Commits

16af1dc 🚀 Release v0.6.0 (#197)
f1427ce ✨ NEW: sync tabs by URL query parameters (#196)
a6f97b8 🐛 FIX: do not close input tag (#195)
e258b45 👌 Use reference name by default for internal link cards (#183)
3374383 ✨ NEW: Create custom directives (#194)
af64472 🔧 Add FIPS compliant flag to md5 call (#162)
074f21f 👌 Remove duplicate CSS hashing for sphinx >= 7.1 (#193)
be1b85d 🐛 Fix tab-item label with nested syntax (#135)
89aaa26 👌 Improve dropdown title bar (#192)
169c09d 📚 Change syntax dropdown color (#191)
Additional commits viewable in compare view

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 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 <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
@dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
@dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
@dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
@dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions

Bumps the sphinx group with 5 updates: | Package | From | To | | --- | --- | --- | | [sphinx](https://github.com/sphinx-doc/sphinx) | `7.2.6` | `7.3.7` | | [sphinx-autobuild](https://github.com/sphinx-doc/sphinx-autobuild) | `2024.2.4` | `2024.4.16` | | [sphinx-gallery](https://github.com/sphinx-gallery/sphinx-gallery) | `0.15.0` | `0.16.0` | | [sphinx-notfound-page](https://github.com/readthedocs/sphinx-notfound-page) | `1.0.0` | `1.0.2` | | [sphinx-design](https://github.com/executablebooks/sphinx-design) | `0.5.0` | `0.6.0` | Updates `sphinx` from 7.2.6 to 7.3.7 - [Release notes](https://github.com/sphinx-doc/sphinx/releases) - [Changelog](https://github.com/sphinx-doc/sphinx/blob/master/CHANGES.rst) - [Commits](sphinx-doc/sphinx@v7.2.6...v7.3.7) Updates `sphinx-autobuild` from 2024.2.4 to 2024.4.16 - [Release notes](https://github.com/sphinx-doc/sphinx-autobuild/releases) - [Changelog](https://github.com/sphinx-doc/sphinx-autobuild/blob/main/NEWS.rst) - [Commits](sphinx-doc/sphinx-autobuild@2024.02.04...2024.04.16) Updates `sphinx-gallery` from 0.15.0 to 0.16.0 - [Release notes](https://github.com/sphinx-gallery/sphinx-gallery/releases) - [Changelog](https://github.com/sphinx-gallery/sphinx-gallery/blob/master/.github_changelog_generator) - [Commits](sphinx-gallery/sphinx-gallery@v0.15.0...v0.16.0) Updates `sphinx-notfound-page` from 1.0.0 to 1.0.2 - [Changelog](https://github.com/readthedocs/sphinx-notfound-page/blob/main/CHANGELOG.rst) - [Commits](readthedocs/sphinx-notfound-page@1.0.0...1.0.2) Updates `sphinx-design` from 0.5.0 to 0.6.0 - [Release notes](https://github.com/executablebooks/sphinx-design/releases) - [Changelog](https://github.com/executablebooks/sphinx-design/blob/main/CHANGELOG.md) - [Commits](executablebooks/sphinx-design@v0.5.0...v0.6.0) --- updated-dependencies: - dependency-name: sphinx dependency-type: direct:production update-type: version-update:semver-minor dependency-group: sphinx - dependency-name: sphinx-autobuild dependency-type: direct:production update-type: version-update:semver-minor dependency-group: sphinx - dependency-name: sphinx-gallery dependency-type: direct:production update-type: version-update:semver-minor dependency-group: sphinx - dependency-name: sphinx-notfound-page dependency-type: direct:production update-type: version-update:semver-patch dependency-group: sphinx - dependency-name: sphinx-design dependency-type: direct:production update-type: version-update:semver-minor dependency-group: sphinx ... Signed-off-by: dependabot[bot] <[email protected]>

requirements_docs.txt

dependabot · 2024-06-21T11:22:57Z

This pull request was built based on a group rule. Closing it will not ignore any of these versions in future pull requests.

To ignore these dependencies, configure ignore rules in dependabot.yml

dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Jun 21, 2024

tkoyama010 previously approved these changes Jun 21, 2024

View reviewed changes

tkoyama010 enabled auto-merge (squash) June 21, 2024 09:36

Merge branch 'main' into dependabot/pip/sphinx-40052fb1d6

77f21d6

tkoyama010 reviewed Jun 21, 2024

View reviewed changes

requirements_docs.txt Outdated Show resolved Hide resolved

tkoyama010 dismissed their stale review via 1930894 June 21, 2024 10:53

tkoyama010 added 2 commits June 21, 2024 19:53

Apply suggestions from code review

1930894

Merge branch 'main' into dependabot/pip/sphinx-40052fb1d6

db1c05e

tkoyama010 closed this Jun 21, 2024

auto-merge was automatically disabled June 21, 2024 11:22
Pull request was closed

tkoyama010 deleted the dependabot/pip/sphinx-40052fb1d6 branch June 21, 2024 11:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump the sphinx group with 5 updates #280

Bump the sphinx group with 5 updates #280

dependabot bot commented on behalf of github Jun 21, 2024 •

edited

Loading

dependabot bot commented on behalf of github Jun 21, 2024

Bump the sphinx group with 5 updates #280

Bump the sphinx group with 5 updates #280

Conversation

dependabot bot commented on behalf of github Jun 21, 2024 • edited Loading

Sphinx 7.3.7

Sphinx 7.3.6

Sphinx 7.3.5

Sphinx 7.3.4

Sphinx 7.3.3

Sphinx 7.3.2

Sphinx 7.3.1

Sphinx 7.3.0

Release 7.3.7 (released Apr 19, 2024)

Bugs fixed

Release 7.3.6 (released Apr 17, 2024)

Bugs fixed

Release 7.3.5 (released Apr 17, 2024)

Bugs fixed

Release 7.3.4 (released Apr 17, 2024)

Bugs fixed

Release 7.3.3 (released Apr 17, 2024)

Bugs fixed

Release 2024.04.16

Release 2024.04.13

Changelog

unreleased

2024.04.16 - 2024-04-16

2024.04.13 - 2024-04-13

2024.02.04 - 2024-02-04

2021.03.14 - 2021-03-14

2020.09.01 - 2020-09-01

Release v0.16.0

Version 1.0.2

Version 1.0.1

v0.6.0

What's Changed

Dependencies

New

✨ Create custom directives

✨ sync tabs by URL query parameters

0.6.0 - 2024-05-23

Dependencies

New

✨ Create custom directives

✨ sync tabs by URL query parameters

dependabot bot commented on behalf of github Jun 21, 2024

dependabot bot commented on behalf of github Jun 21, 2024 •

edited

Loading