Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump the doc-dependencies group across 1 directory with 7 updates #889

Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 23, 2024

Bumps the doc-dependencies group with 7 updates in the / directory:

Package From To
ansys-sphinx-theme 0.15.2 1.0.11
numpydoc 1.7.0 1.8.0
sphinx 7.2.6 8.0.2
sphinx-design 0.6.0 0.6.1
sphinx-autodoc-typehints 2.0.1 2.4.4
sphinx-gallery 0.15.0 0.17.1
sphinx-notfound-page 1.0.0 1.0.4

Updates ansys-sphinx-theme from 0.15.2 to 1.0.11

Commits
  • 2e74ef0 chore: updating CHANGELOG for v1.0.11
  • d7ce00c release: bump version 1.0.11
  • 87bf123 fix: location of nbsphinx (#506)
  • 6c0917f chore: updating CHANGELOG for v1.0.10
  • f5584d6 release: bump version 1.0.10
  • 5a51f86 chore: updating CHANGELOG for v1.0.9
  • 0ad5dac release: Bump version 1.0.9
  • 638b34d feat: add member_order to autoapi (#495)
  • a76dde0 chore: updating CHANGELOG for v1.0.8
  • be2ca19 release: Bump version 1.0.8
  • Additional commits viewable in compare view

Updates numpydoc from 1.7.0 to 1.8.0

Commits

Updates sphinx from 7.2.6 to 8.0.2

Release notes

Sourced from sphinx's releases.

Sphinx 8.0.2

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

Sphinx 8.0.1

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

Sphinx 8.0.0

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

Dependencies

  • #12633: Drop Python 3.9 support.

Incompatible changes

  • Remove deprecated functions from sphinx.util:

    • Removed sphinx.util.path_stabilize (use sphinx.util.osutil.path_stabilize).
    • Removed sphinx.util.display_chunk (use sphinx.util.display.display_chunk).
    • Removed sphinx.util.status_iterator (use sphinx.util.display.status_iterator).
    • Removed sphinx.util.SkipProgressMessage (use sphinx.util.display.SkipProgressMessage).
    • Removed sphinx.util.progress_message (use sphinx.util.display.progress_message).
    • Removed sphinx.util.epoch_to_rfc1123 (use sphinx.http_date.epoch_to_rfc1123).
    • Removed sphinx.util.rfc1123_to_epoch (use sphinx.http_date.rfc1123_to_epoch).
    • Removed sphinx.util.save_traceback (use sphinx.exceptions.save_traceback).
    • Removed sphinx.util.format_exception_cut_frames (use sphinx.exceptions.format_exception_cut_frames).
    • Removed sphinx.util.xmlname_checker (use sphinx.builders.epub3._XML_NAME_PATTERN).

    Patch by Adam Turner.

  • Removed sphinx.util.osutil.cd (use contextlib.chdir). Patch by Adam Turner.

  • Removed sphinx.util.typing.stringify (use sphinx.util.typing.stringify_annotation). Patch by Adam Turner.

  • #12593: Raise an error for invalid html_sidebars values. Patch by Adam Turner.

  • #12593: Raise an error in Theme.get_config for invalid sections.

... (truncated)

Changelog

Sourced from sphinx's changelog.

Release 8.0.2 (released Jul 30, 2024)

Bugs fixed

  • Fix the pygments.Formatter.__class_getitem__ patch. Patch by Adam Turner.

Release 8.0.1 (released Jul 30, 2024)

Bugs fixed

  • Patch pygments.Formatter.__class_getitem__ in Pygments 2.17. Patch by Adam Turner.

Release 8.0.0 (released Jul 29, 2024)

Dependencies

  • #12633: Drop Python 3.9 support.

Incompatible changes

.. rst-class:: compact

  • Remove deprecated functions from sphinx.util:

    • Removed sphinx.util.path_stabilize (use sphinx.util.osutil.path_stabilize).
    • Removed sphinx.util.display_chunk (use sphinx.util.display.display_chunk).
    • Removed sphinx.util.status_iterator (use sphinx.util.display.status_iterator).
    • Removed sphinx.util.SkipProgressMessage (use sphinx.util.display.SkipProgressMessage).
    • Removed sphinx.util.progress_message (use sphinx.util.display.progress_message).
    • Removed sphinx.util.epoch_to_rfc1123 (use sphinx.http_date.epoch_to_rfc1123).
    • Removed sphinx.util.rfc1123_to_epoch (use sphinx.http_date.rfc1123_to_epoch).
    • Removed sphinx.util.save_traceback (use sphinx.exceptions.save_traceback).
    • Removed sphinx.util.format_exception_cut_frames

... (truncated)

Commits

Updates sphinx-design from 0.6.0 to 0.6.1

Release notes

Sourced from sphinx-design's releases.

v0.6.1

What's Changed

Full Changelog: executablebooks/sphinx-design@v0.6.0...v0.6.1

Changelog

Sourced from sphinx-design's changelog.

0.6.1 - 2024-08-02

  • ⬆️ Update sphinx to >=6,<9 by {user}chrisjsewell in {pr}212
  • 👌 Reduce right-padding of dropdown title by {user}chrisjsewell in {pr}198
Commits

Updates sphinx-autodoc-typehints from 2.0.1 to 2.4.4

Release notes

Sourced from sphinx-autodoc-typehints's releases.

Fix broken link in README

Full Changelog: tox-dev/sphinx-autodoc-typehints@2.4.3...2.4.4

2.4.3

Full Changelog: tox-dev/sphinx-autodoc-typehints@2.4.2...2.4.3

2.4.2

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@2.4.1...2.4.2

2.4.1

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@2.4.0...2.4.1

2.4.0

  • Drop 3.9 support
  • Add 3.13 support
  • Bump dependencies

Full Changelog: tox-dev/sphinx-autodoc-typehints@2.3.0...2.4.0

2.3.0

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@2.2.3...2.3.0

... (truncated)

Commits

Updates sphinx-gallery from 0.15.0 to 0.17.1

Release notes

Sourced from sphinx-gallery's releases.

Release v0.17.1

Full Changelog

Fixed bugs:

  • FIX: Fix stability of stored compiled regex #1369 (larsoner)
  • ENH: Improve _sanitize_rst #1366 (timhoffm)
  • Obey prefer_full_module setting when finding backreferences #1364 (QuLogic)
  • Fix linking to class attributes with prefer_full_module #1363 (QuLogic)
  • Improve minigallery directive path input resolution #1360 (lucyleeow)
  • FIX Allow str path minigallery entries when backreferences off #1355 (lucyleeow)
  • FIX generate zipfiles when index passed by user #1353 (lucyleeow)

Documentation

Project maintenance

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

... (truncated)

Commits

Updates sphinx-notfound-page from 1.0.0 to 1.0.4

Changelog

Sourced from sphinx-notfound-page's changelog.

Version 1.0.4

:Date: Jul 31, 2024

  • Fix issue when installing with Sphinx 7.2.x and notfound_urls_prefix=None

Version 1.0.3

:Date: Jul 30, 2024

  • Fix _Opt deprecation warning

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
  • be376e2 Release 1.0.4
  • 4a7a4db fix: Error with sphinx-notfound-page 1.0.3 - 'tuple' object has no at… (#241)
  • fe10592 Tests: update test suite and fix some tests (#242)
  • c628442 Release 1.0.3
  • 9b0cc7d fix: check prefix starts and ends with / (#238)
  • 64ed88f fix _Opt deprecation warning (#236)
  • 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)
  • 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 doc-dependencies group with 7 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [ansys-sphinx-theme](https://github.com/ansys/ansys-sphinx-theme) | `0.15.2` | `1.0.11` |
| [numpydoc](https://github.com/numpy/numpydoc) | `1.7.0` | `1.8.0` |
| [sphinx](https://github.com/sphinx-doc/sphinx) | `7.2.6` | `8.0.2` |
| [sphinx-design](https://github.com/executablebooks/sphinx-design) | `0.6.0` | `0.6.1` |
| [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints) | `2.0.1` | `2.4.4` |
| [sphinx-gallery](https://github.com/sphinx-gallery/sphinx-gallery) | `0.15.0` | `0.17.1` |
| [sphinx-notfound-page](https://github.com/readthedocs/sphinx-notfound-page) | `1.0.0` | `1.0.4` |



Updates `ansys-sphinx-theme` from 0.15.2 to 1.0.11
- [Release notes](https://github.com/ansys/ansys-sphinx-theme/releases)
- [Commits](ansys/ansys-sphinx-theme@v0.15.2...v1.0.11)

Updates `numpydoc` from 1.7.0 to 1.8.0
- [Release notes](https://github.com/numpy/numpydoc/releases)
- [Changelog](https://github.com/numpy/numpydoc/blob/main/RELEASE.rst)
- [Commits](numpy/numpydoc@v1.7.0...v1.8.0)

Updates `sphinx` from 7.2.6 to 8.0.2
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/v8.0.2/CHANGES.rst)
- [Commits](sphinx-doc/sphinx@v7.2.6...v8.0.2)

Updates `sphinx-design` from 0.6.0 to 0.6.1
- [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.6.0...v0.6.1)

Updates `sphinx-autodoc-typehints` from 2.0.1 to 2.4.4
- [Release notes](https://github.com/tox-dev/sphinx-autodoc-typehints/releases)
- [Changelog](https://github.com/tox-dev/sphinx-autodoc-typehints/blob/main/CHANGELOG.md)
- [Commits](tox-dev/sphinx-autodoc-typehints@2.0.1...2.4.4)

Updates `sphinx-gallery` from 0.15.0 to 0.17.1
- [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.17.1)

Updates `sphinx-notfound-page` from 1.0.0 to 1.0.4
- [Changelog](https://github.com/readthedocs/sphinx-notfound-page/blob/main/CHANGELOG.rst)
- [Commits](readthedocs/sphinx-notfound-page@1.0.0...1.0.4)

---
updated-dependencies:
- dependency-name: ansys-sphinx-theme
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: doc-dependencies
- dependency-name: numpydoc
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: doc-dependencies
- dependency-name: sphinx
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: doc-dependencies
- dependency-name: sphinx-design
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: doc-dependencies
- dependency-name: sphinx-autodoc-typehints
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: doc-dependencies
- dependency-name: sphinx-gallery
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: doc-dependencies
- dependency-name: sphinx-notfound-page
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: doc-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Related with project dependencies maintenance Package and maintenance related labels Sep 23, 2024
github-actions[bot]
github-actions bot previously approved these changes Sep 23, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 1, 2024
@AlejandroFernandezLuces
Copy link
Contributor

@Revathyvenugopal162 I'm getting warnings because due to some incompatibility with intEnum class and Sphinx. I can just ignore the warnings to make the docs work, but are you aware of any fix for this?

The error is the same as this one: https://stackoverflow.com/questions/77914856/sphinx-raises-warnings-for-class-derived-from-intenum-can-i-do-something-about

@Revathyvenugopal162
Copy link
Contributor

@Revathyvenugopal162 I'm getting warnings because due to some incompatibility with intEnum class and Sphinx. I can just ignore the warnings to make the docs work, but are you aware of any fix for this?

The error is the same as this one: https://stackoverflow.com/questions/77914856/sphinx-raises-warnings-for-class-derived-from-intenum-can-i-do-something-about

supress the particular warning should work, and did you try to add :inherited-members: int in the autodoc options?

@AlejandroFernandezLuces
Copy link
Contributor

I tried to add this:

supress_warnings = ["docutils"]

But it doesn't suppress the warning, not sure why. How should I use :inherited-members: int? This warning is being raised in the autogenerated API, so not sure if this would work. In any case this is not super critical, the documentation works fine.

@AlejandroFernandezLuces
Copy link
Contributor

Merging, if any further fix is needed we can work on another PR in any case

@AlejandroFernandezLuces AlejandroFernandezLuces merged commit 99d25eb into main Oct 1, 2024
25 checks passed
@AlejandroFernandezLuces AlejandroFernandezLuces deleted the dependabot/pip/doc-dependencies-69deb05b3b branch October 1, 2024 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Related with project dependencies documentation Improvements or additions to documentation maintenance Package and maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants