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

build(deps): bump sphinx from 5.1.1 to 5.2.3 #1653

Merged
merged 4 commits into from Oct 14, 2022

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 3, 2022

Bumps sphinx from 5.1.1 to 5.2.3.

Release notes

Sourced from sphinx's releases.

v5.2.3

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

v5.2.2

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

v5.2.1

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

v5.2.0

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

Changelog

Sourced from sphinx's changelog.

Release 5.2.3 (released Sep 30, 2022)

  • #10878: Fix base64 image embedding in sphinx.ext.imgmath
  • #10886: Add :nocontentsentry: flag and global domain table of contents entry control option. Patch by Adam Turner

Release 5.2.2 (released Sep 27, 2022)

  • #10872: Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster.

Release 5.2.1 (released Sep 25, 2022)

Bugs fixed

  • #10861: Always normalise the pycon3 lexer to pycon.
  • Fix using sphinx.ext.autosummary with modules containing titles in the module-level docstring.

Release 5.2.0.post0 (released Sep 24, 2022)

  • Recreated source tarballs for Debian maintainers.

Release 5.2.0 (released Sep 24, 2022)

Dependencies

  • #10356: Sphinx now uses declarative metadata with pyproject.toml to create packages, using PyPA's flit project as a build backend. Patch by Adam Turner.

Deprecated

  • #10843: Support for HTML 4 output. Patch by Adam Turner.

Features added

  • #10738: napoleon: Add support for docstring types using 'of', like type of type. Example: tuple of int.
  • #10286: C++, support requires clauses not just between the template parameter lists and the declaration.

... (truncated)

Commits

Dependabot compatibility score

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 ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file python labels Oct 3, 2022
@pradyunsg
Copy link

pradyunsg commented Oct 3, 2022

It would be great if this PR could be landed (and the docs generated with the newer version of Sphinx).

Specifically due to this change in Sphinx, which would make reading the API reference easier:

#6316, #10804: Add domain objects to the table of contents. Patch by Adam Turner

PS: Consider changing the API reference theme to Furo, which has significantly better API documentation presentation; although, I'll admit I'm biased as the author of that theme. The migration is usually quite simple (you'll want to replace sphinx-rtd-theme/alabaster with furo).

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 5.1.1 to 5.2.3.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/5.x/CHANGES)
- [Commits](sphinx-doc/sphinx@v5.1.1...v5.2.3)

---
updated-dependencies:
- dependency-name: sphinx
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/sphinx-5.2.3 branch from dab66de to 23ba6b9 Compare October 3, 2022 15:37
@antonpirker antonpirker enabled auto-merge (squash) October 14, 2022 11:32
@antonpirker antonpirker merged commit af1ece2 into master Oct 14, 2022
@antonpirker antonpirker deleted the dependabot/pip/sphinx-5.2.3 branch October 14, 2022 12:22
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants