build: bump the documentation group with 3 updates

[dependabot]

Bumps the documentation group with 3 updates: plotly, sphinx-gallery and sphinx.

Updates plotly from 5.22.0 to 5.23.0

Release notes

Sourced from plotly's releases.

v5.23.0

Updated

• Updated Plotly.js from version 2.32.0 to version 2.34.0. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
  • Add subtitle attribute to layout.title to enable adding subtitles to plots [#7012]
  • Introduce "u" and "s" pseudo html tags to add partial underline and strike-through styles to SVG text elements [#7043]
  • Add geometric mean functionality and 'geometric mean ascending' + 'geometric mean descending' to category_order on cartesian axes [#6223], with thanks to @​acxz and @​prabhathc for the contribution!
  • Add axis property ticklabelindex for drawing the label for each minor tick n positions away from a major tick, with thanks to @​my-tien for the contribution! [#7036]
  • Add property ticklabelstandoff and ticklabelshift to cartesian axes to adjust positioning of tick labels, with thanks to @​my-tien for the contribution! [#7006]
  • Add x0shift, x1shift, y0shift, y1shift to shapes to add control over positioning of shape vertices on (multi-)category axes, with thanks to @​my-tien for the contribution! [#7005]

Changelog

Sourced from plotly's changelog.

[5.23.0] - 2024-07-23

Updated

• Updated Plotly.js from version 2.32.0 to version 2.34.0. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
  • Add subtitle attribute to layout.title to enable adding subtitles to plots [#7012]
  • Introduce "u" and "s" pseudo html tags to add partial underline and strike-through styles to SVG text elements [#7043]
  • Add geometric mean functionality and 'geometric mean ascending' + 'geometric mean descending' to category_order on cartesian axes [#6223], with thanks to @​acxz and @​prabhathc for the contribution!
  • Add axis property ticklabelindex for drawing the label for each minor tick n positions away from a major tick, with thanks to @​my-tien for the contribution! [#7036]
  • Add property ticklabelstandoff and ticklabelshift to cartesian axes to adjust positioning of tick labels, with thanks to @​my-tien for the contribution! [#7006]
  • Add x0shift, x1shift, y0shift, y1shift to shapes to add control over positioning of shape vertices on (multi-)category axes, with thanks to @​my-tien for the contribution! [#7005]
• Specify Python version 3.8-3.11 for development virtual environments and pin pytest at version 8.1.1 to match.
• Update IntegerValidator to handle extras option to allow supporting additional keyword values. For example, 'bold' and 'normal' as well as integers as used in font weights #4612.

Commits

• 83c7c85 version changes for v5.23.0
• bf78a8a Merge pull request #4683 from plotly/add-latest-docs-updates
• a32a981 Merge branch 'master' into add-latest-docs-updates
• 9b5ec6a Merge pull request #4627 from plotly/update-plotly-js-version
• bcbc571 Merge branch 'master' into update-plotly-js-version
• e5fdd7c add text annotation example
• 3de6e25 Merge pull request #4679 from plotly/fix-maps-docstring
• 44bf20c specify which maps require token
• 059433f add plot subtitle example
• b9e178d update plotly.js to 2.34.0
• Additional commits viewable in compare view

Updates sphinx-gallery from 0.16.0 to 0.17.0

Release notes

Sourced from sphinx-gallery's releases.

Release v0.17.0

Support for Python 3.8 and Sphinx 4 dropped in this release. Requirement is now Python >= 3.9 and Sphinx >= 5.

Full Changelog

Implemented enhancements:

• Introduction tooltip corresponds to the first paragraph #1344 (fgmacedo)
• FIX Jupyterlite in CircleCI artifact #1336 (lesteve)
• MNT: Rename README.rst to GALLERY_HEADER.rst #1321 (timhoffm)
• [ENH] Add custom thumbnails for failing examples #1313 (tsbinns)
• ENH integrate download/launcher links into pydata-sphinx-theme secondary sidebar #1312 (Charlie-XIAO)
• add option for zip downloads #1299 (jamiecook)
• Allow setting animation format from gallery config #1243 (QuLogic)

Fixed bugs:

• Fix handling of multi-module intersphinx registries #1320 (QuLogic)
• BUG: Fix bug with traceback with SyntaxError #1301 (larsoner)

Documentation

• DOC Add napari to users #1346 (lucyleeow)
• DOC Fix nested_sections #1339 (lucyleeow)
• DOC Improve nested_sections #1326 (lucyleeow)
• DOC: Remove definition lists from contribution guide #1318 (QuLogic)
• MNT: fixed documentation links in the readme #1310 (story645)

Project maintenance

• [pre-commit.ci] pre-commit autoupdate #1348 (pre-commit-ci[bot])
• MNT: Fix gallery_conf changes do not need to be returned #1347 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1345 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1342 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1338 (pre-commit-ci[bot])
• MNT: Sort imports and add to pre commit #1337 (lucyleeow)
• MNT: Refactor generate_file_rst #1335 (lucyleeow)
• MNT: Refactor _fill_gallery_conf_defaults #1334 (lucyleeow)
• MNT Use os.sep everywhere #1333 (lucyleeow)
• MNT: Refactor generate_dir_rst and generate_gallery_rst #1332 (lucyleeow)
• MNT: Add ipython to dev dependencies #1329 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1328 (pre-commit-ci[bot])
• Fix make file clean in tinybuild #1327 (lucyleeow)
• Bump the actions group with 5 updates #1325 (dependabot[bot])
• [pre-commit.ci] pre-commit autoupdate #1324 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1319 (pre-commit-ci[bot])
• Include dev dependencies in pyproject.toml and update docs on requirements #1317 (AlexSzatmary)
• [pre-commit.ci] pre-commit autoupdate #1314 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1311 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1307 (pre-commit-ci[bot])

... (truncated)

Commits

• 45403b6 MNT: Release 0.17.0 (#1349)
• d2c8e47 [ENH] Add custom thumbnails for failing examples (#1313)
• 73b7ec8 [pre-commit.ci] pre-commit autoupdate (#1348)
• 6b379ca MNT: Fix gallery_conf changes do not need to be returned (#1347)
• 51cbf73 Introduction tooltip corresponds to the first paragraph (#1344)
• 69007ef DOC Add napari to users (#1346)
• 1b4aecd ENH: Parallel gallery generation (#877)
• cf81205 [pre-commit.ci] pre-commit autoupdate (#1345)
• 764656c [pre-commit.ci] pre-commit autoupdate (#1342)
• 40f7589 DOC Fix nested_sections (#1339)
• Additional commits viewable in compare view

Updates sphinx from 7.4.6 to 7.4.7

Release notes

Sourced from sphinx's releases.

Sphinx 7.4.7

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

Changelog

Sourced from sphinx's changelog.

Release 7.4.7 (released Jul 20, 2024)

Bugs fixed

• #12096: Warn when files are overwritten in the build directory. Patch by Adam Turner and Bénédikt Tran.
• #12620: Ensure that old-style object description options are respected. Patch by Adam Turner.
• #12601, #12625: Support callable objects in :py:class:~typing.Annotated type metadata in the Python domain. Patch by Adam Turner.
• #12601, #12622: Resolve :py:class:~typing.Annotated warnings with sphinx.ext.autodoc, especially when using :mod:dataclasses as type metadata. Patch by Adam Turner.
• #12589, #12626: autosummary: Fix warnings with :rst:role:!autolink. Patch by Adam Turner.

Commits

• 0d912c8 Bump to 7.4.7 final
• bbc97e0 autosummary: Filter invalid import prefixes in autolink (#12626)
• 6c486a5 Fix detecting file changes for the overwritten file warning (#12627)
• 2bd973e autodoc: Fix warnings with dataclasses in Annotated metadata (#12622)
• dd77f85 Support callables in Annotated types (#12625)
• 1ed4ca7 Mark test_build_manpage as XFAIL following changes in Docutils master
• cd8ce07 Update message catalogues following reverted commits
• c6cd25f Partially revert "Update message catalogues (#11626)"
• fa2ba7d Partially Revert "[bot]: Update message catalogues (#12563)"
• e439c6f Ensure that old-style object description options are respected (#12620)
• 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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.15%. Comparing base (a7dc074) to head (9d8949d).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3311      +/-   ##
==========================================
- Coverage   87.16%   87.15%   -0.02%     
==========================================
  Files          55       55              
  Lines        9768     9768              
==========================================
- Hits         8514     8513       -1     
- Misses       1254     1255       +1