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 #217

Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 1, 2023

Updates the requirements on sphinx and sphinx-autoapi to permit the latest version.
Updates sphinx to 7.1.2

Release notes

Sourced from sphinx's releases.

Sphinx 7.1.2

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

Changelog

Sourced from sphinx's changelog.

Release 7.1.2 (released Aug 02, 2023)

Bugs fixed

  • #11542: linkcheck: Properly respect :confval:linkcheck_anchors and do not spuriously report failures to validate anchors. Patch by James Addison.

Release 7.1.1 (released Jul 27, 2023)

Bugs fixed

  • #11514: Fix SOURCE_DATE_EPOCH in multi-line copyright footer. Patch by Bénédikt Tran.

Release 7.1.0 (released Jul 24, 2023)

Incompatible changes

Deprecated

  • #11412: Emit warnings on using a deprecated Python-specific index entry type (namely, module, keyword, operator, object, exception, statement, and builtin) in the :rst:dir:index directive, and set the removal version to Sphinx 9. Patch by Adam Turner.

Features added

  • #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
  • :meth:~sphinx.application.Sphinx.require_sphinx now allows the version requirement to be specified as (major, minor).
  • #11011: Allow configuring a line-length limit for object signatures, via :confval:maximum_signature_line_length and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list.

... (truncated)

Commits

Updates sphinx-autoapi to 3.0.0

Release notes

Sourced from sphinx-autoapi's releases.

v3.0.0

Bugfixes

  • Ensure tooltip is always a str
  • Replaced usage of deprecated sphinx.util.status_iterator (#391)

Deprecations and Removals

  • Removed support for documenting languages other than Python (#248)
  • Removed support for Python 3.7

Misc

Changelog

Sourced from sphinx-autoapi's changelog.

v3.0.0 (2023-09-26)

Bugfixes ^^^^^^^^

  • Ensure tooltip is always a str. (str-tooltip)
  • Replaced usage of deprecated sphinx.util.status_iterator (#391)

Deprecations and Removals ^^^^^^^^^^^^^^^^^^^^^^^^^

  • Removed support for documenting languages other than Python (#248)
  • Removed support for Python 3.7

Misc ^^^^

v2.1.1 (2023-06-10)

Bugfixes ^^^^^^^^

  • Fix "document isn't included" warning when using autoapi_add_toctree_entry (#319)
  • Types used in PEP-604 union syntax can be linked with intersphinx (#366)
  • Fix class overrides not rendering correctly.
  • Fix separated type comments for arguments not merging correctly in Python 3.7
  • Fixed viewcode being unable to find the source code for imported objects

Improved Documentation ^^^^^^^^^^^^^^^^^^^^^^

  • Made it clearer how to customise what objects AutoAPI will document. (#339)

Misc ^^^^

v2.1.0 (2023-03-28)

... (truncated)

Commits
  • 006142d Version 3.0.0
  • 6317148 Replace usage of deprecated astroid.NodeNG.doc in inheritance_diagrams.py
  • 4d1bec0 Removed support for Python 3.7
  • cf8abe5 Import fallback for older versions of Sphinx
  • 0186a3c Replace usage of deprecated sphinx.util.status_iterator
  • 92437c9 Removed old pylint pragmas
  • a22ae92 Removed support for documenting languages other than Python
  • 7b90b43 Add news
  • 4ea04f2 Ensure tooltip is always a str
  • 9d970a6 Rename master to main
  • 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

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

Updates `sphinx` to 7.1.2
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/master/CHANGES.rst)
- [Commits](sphinx-doc/sphinx@v6.2.1...v7.1.2)

Updates `sphinx-autoapi` to 3.0.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@v2.1.1...v3.0.0)

---
updated-dependencies:
- dependency-name: sphinx
  dependency-type: direct:development
  dependency-group: documentation-dependencies
- dependency-name: sphinx-autoapi
  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 Oct 1, 2023
@djperrefort djperrefort merged commit c3efb56 into main Oct 2, 2023
12 checks passed
@djperrefort djperrefort deleted the dependabot/pip/documentation-dependencies-2d59f2f902 branch October 2, 2023 19:29
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