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 documentation-dependencies group with 2 updates #274

Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Dec 1, 2024

Updates the requirements on sphinx-autoapi and sphinx-rtd-theme to permit the latest version.
Updates sphinx-autoapi to 3.4.0

Release notes

Sourced from sphinx-autoapi's releases.

v3.4.0

Features

  • NamedTuples that have been created with functional syntax are documented as a class (#485)

Misc

Changelog

Sourced from sphinx-autoapi's changelog.

v3.4.0 (2024-11-29)

Features ^^^^^^^^

  • NamedTuples that have been created with functional syntax are documented as a class (#485)

Misc ^^^^

v3.3.3 (2024-10-25)

Bugfixes ^^^^^^^^

  • Document packages and modules under a single "submodules" heading (#450)
  • Fix crash when init is assigned to (#488)
  • Fix documenting incorrect attributes from init (#497)

Misc ^^^^

v3.3.2 (2024-09-25)

Bugfixes ^^^^^^^^

  • Fix types missing from documentation generated by autodoc-style directives. (#473)

v3.3.1 (2024-09-01)

Bugfixes ^^^^^^^^

  • Fix all class members missing when documenting a module with the same name as a standard library module

    Members inherited from the standard library can also have their skip value

... (truncated)

Commits
  • 9e6a70a Version 3.4.0
  • b3f768e NamedTuples are always documented as a class
  • 6f91543 Format Python code with ruff format instead of black (#498)
  • b2ff263 Keep GitHub Actions up to date with GitHub's Dependabot
  • 4e2d9ae Fix ruff compressions and performance issues (#490)
  • f5c7295 Version 3.3.3
  • eb2d7f2 Fix crash when init is assigned to
  • 0e9bb9b Document package and modules under a "submodules" heading
  • 53c2abc Attach release note to correct issue
  • 489abb1 Add missing release note
  • Additional commits viewable in compare view

Updates sphinx-rtd-theme to 3.0.2

Changelog

Sourced from sphinx-rtd-theme's changelog.

3.0.2

  • Show current translation when the flyout is attached
  • Fix JavaScript issue that didn't allow users to disable selectors

.. _release-3.0.1:

3.0.1

  • Use black color for text in selectors.

.. _release-3.0.0:

3.0.0

Final version.

.. _release-3.0.0rc4:

3.0.0rc4

Fixes

  • Trigger "Read the Docs Search addon" when focusing the "Search docs" input in the navbar.

.. _release-3.0.0rc3:

3.0.0rc3

Fixes

  • Show hidden version in selector if it's the current active version

.. _release-3.0.0rc2:

3.0.0rc2

Added

  • Render version and language selectors below the documentation's title (top left). This can be controlled via the new theme options version_selector and language_selector.

... (truncated)

Commits

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

Updates the requirements on [sphinx-autoapi](https://github.com/readthedocs/sphinx-autoapi) and [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) to permit the latest version.

Updates `sphinx-autoapi` to 3.4.0
- [Release notes](https://github.com/readthedocs/sphinx-autoapi/releases)
- [Changelog](https://github.com/readthedocs/sphinx-autoapi/blob/main/CHANGELOG.rst)
- [Commits](readthedocs/sphinx-autoapi@v3.2.1...v3.4.0)

Updates `sphinx-rtd-theme` to 3.0.2
- [Changelog](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/changelog.rst)
- [Commits](readthedocs/sphinx_rtd_theme@2.0.0...3.0.2)

---
updated-dependencies:
- dependency-name: sphinx-autoapi
  dependency-type: direct:development
  dependency-group: documentation-dependencies
- dependency-name: sphinx-rtd-theme
  dependency-type: direct:development
  dependency-group: documentation-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Dec 1, 2024
@djperrefort djperrefort merged commit 0c31f9d into main Dec 11, 2024
11 checks passed
@djperrefort djperrefort deleted the dependabot/pip/documentation-dependencies-6828938a92 branch December 11, 2024 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant