Skip to content

chore(deps-dev): Bump sphinx from 4.0.3 to 4.1.0 #551

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

Merged
merged 1 commit into from
Jul 12, 2021

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jul 12, 2021

Bumps sphinx from 4.0.3 to 4.1.0.

Changelog

Sourced from sphinx's changelog.

Release 4.1.0 (released Jul 12, 2021)

Dependencies

  • Support jinja2-3.0

Deprecated

  • The app argument of sphinx.environment.BuildEnvironment becomes required
  • sphinx.application.Sphinx.html_theme
  • sphinx.ext.autosummary._app
  • sphinx.util.docstrings.extract_metadata()

Features added

  • #8107: autodoc: Add class-doc-from option to :rst:dir:autoclass directive to control the content of the specific class like :confval:autoclass_content
  • #8588: autodoc: :confval:autodoc_type_aliases now supports dotted name. It allows you to define an alias for a class with module name like foo.bar.BazClass
  • #9175: autodoc: Special member is not documented in the module
  • #9195: autodoc: The arguments of typing.Literal are wrongly rendered
  • #9185: autodoc: :confval:autodoc_typehints allows 'both' setting to allow typehints to be included both in the signature and description
  • #4257: autodoc: Add :confval:autodoc_class_signature to separate the class entry and the definition of __init__() method
  • #8061, #9218: autodoc: Support variable comment for alias classes
  • #3014: autodoc: Add :event:autodoc-process-bases to modify the base classes of the class definitions
  • #9272: autodoc: Render enum values for the default argument value better
  • #9384: autodoc: autodoc_typehints='none' now erases typehints for variables, attributes and properties
  • #3257: autosummary: Support instance attributes for classes
  • #9358: html: Add "heading" role to the toctree items
  • #9225: html: Add span tag to the return typehint of method/function
  • #9129: html search: Show search summaries when html_copy_source = False
  • #9307: html search: Prevent corrections and completions in search field
  • #9120: html theme: Eliminate prompt characters of code-block from copyable text
  • #9176: i18n: Emit a debug message if message catalog file not found under :confval:locale_dirs
  • #9414: LaTeX: Add xeCJKVerbAddon to default fvset config for Chinese documents
  • #9016: linkcheck: Support checking anchors on github.com
  • #9016: linkcheck: Add a new event :event:linkcheck-process-uri to modify

... (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)

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 4.0.3 to 4.1.0.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/4.x/CHANGES)
- [Commits](sphinx-doc/sphinx@v4.0.3...v4.1.0)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python labels Jul 12, 2021
@codecov-commenter
Copy link

Codecov Report

Merging #551 (c80ae5e) into main (12eff70) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #551   +/-   ##
=======================================
  Coverage   94.25%   94.25%           
=======================================
  Files          71       71           
  Lines       10263    10263           
  Branches     1072     1072           
=======================================
  Hits         9673     9673           
  Misses        422      422           
  Partials      168      168           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 12eff70...c80ae5e. Read the comment docs.

Copy link
Contributor

@duckontheweb duckontheweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to solve some issues with our type annotations not being incorporated into the API docs.

@duckontheweb duckontheweb merged commit cee997d into main Jul 12, 2021
@dependabot dependabot bot deleted the dependabot/pip/sphinx-4.1.0 branch July 12, 2021 16:28
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.

2 participants