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 sphinx from 3.5.4 to 4.2.0 #461

Closed
wants to merge 2 commits into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 28, 2021

Bumps sphinx from 3.5.4 to 4.2.0.

Changelog

Sourced from sphinx's changelog.

Release 4.2.0 (released Sep 12, 2021)

Features added

  • #9445: autodoc: Support class properties
  • #9479: autodoc: Emit a warning if target is a mocked object
  • #9560: autodoc: Allow to refer NewType instances with module name in Python 3.10 or above
  • #9447: html theme: Expose the version of Sphinx in the form of tuple as a template variable sphinx_version_tuple
  • #9594: manpage: Suppress the title of man page if description is empty
  • #9445: py domain: :py:property: directive supports :classmethod: option to describe the class property
  • #9524: test: SphinxTestApp can take builddir as an argument
  • #9535: C and C++, support more fundamental types, including GNU extensions.

Bugs fixed

  • #9608: apidoc: apidoc does not generate a module definition for implicit namespace package
  • #9504: autodoc: generate incorrect reference to the parent class if the target class inherites the class having _name attribute
  • #9537, #9589: autodoc: Some objects under typing module are not displayed well with the HEAD of 3.10
  • #9487: autodoc: typehint for cached_property is not shown
  • #9509: autodoc: AttributeError is raised on failed resolving typehints
  • #9518: autodoc: autodoc_docstring_signature does not effect to __init__() and __new__()
  • #9522: autodoc: PEP 585 style typehints having arguments (ex. list[int]) are not displayed well
  • #9481: autosummary: some warnings contain non-existing filenames
  • #9568: autosummary: summarise overlined sectioned headings correctly
  • #9600: autosummary: Type annotations which contain commas in autosummary table are not removed completely
  • #9481: c domain: some warnings contain non-existing filenames
  • #9481: cpp domain: some warnings contain non-existing filenames
  • #9456: html search: abbreation marks are inserted to the search result if failed to fetch the content of the page
  • #9617: html search: The JS requirement warning is shown if browser is slow
  • #9267: html theme: CSS and JS files added by theme were loaded twice
  • #9585: py domain: :type: option for :rst:dir:py:property directive does not create a hyperlink
  • #9576: py domain: Literal typehint was converted to a cross reference
  • #9535 comment: C++, fix parsing of defaulted function parameters that are function pointers.
  • #9564: smartquotes: don't adjust typography for text with language-highlighted :code: role.

... (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 3.5.4 to 4.2.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@v3.5.4...v4.2.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the PR type: dependencies 🤖 Contains only dependencies updates label Sep 28, 2021
@github-actions
Copy link

Coverage report

The coverage rate went from 100.0% to 100.0% ➡️

The branch rate is 99.72999999999999%

100% of new lines are covered.

@ewjoachim
Copy link
Member

Sphinx 4 is still failing with sphinx-doc/sphinx#4961

docs       
+ poetry run sphinx-build -EW docs docs/_build/html
Running Sphinx v4.2.0
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 38 source files that are out of date
updating environment: [new config] 38 added, 0 changed, 0 removed
reading sources... [100%] reference                                                                                                               
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] reference                                                                                                                

Warning, treated as error:
/home/joachim/src/procrastinate/docs/discussions.rst:178:more than one target found for 'any' cross-reference 'AiopgConnector': could be :py:class:`procrastinate.AiopgConnector` or :py:class:`procrastinate.aiopg_connector.AiopgConnector`

@ewjoachim
Copy link
Member

@dependabot help

@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 29, 2021

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)

@ewjoachim
Copy link
Member

@dependabot ignore this major version

@dependabot dependabot bot closed this Sep 29, 2021
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 29, 2021

OK, I won't notify you about version 4.x.x again, unless you re-open this PR or update to a 4.x.x release yourself.

@dependabot dependabot bot deleted the dependabot/pip/sphinx-4.2.0 branch September 29, 2021 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR type: dependencies 🤖 Contains only dependencies updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant