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

Update sphinx requirement from <3.4.0,>=3.0.3 to >=3.0.3,<4.2.0 #37

Closed

Conversation

dependabot[bot]
Copy link

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

Updates the requirements on sphinx to permit the latest version.

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

Updates the requirements on [sphinx](https://github.com/sphinx-doc/sphinx) to permit the latest version.
- [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.2.1...v4.1.0)

---
updated-dependencies:
- dependency-name: sphinx
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Jul 12, 2021
@dependabot dependabot bot requested a review from domdfcoding July 12, 2021 17:03
@repo-helper repo-helper bot added failure: Linux The Linux tests are failing. failure: Windows The Windows tests are failing. labels Jul 12, 2021
@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Jul 19, 2021

A newer version of sphinx exists, but since this PR has been edited by someone other than Dependabot I haven't updated it. You'll get a PR for the updated version as normal once this PR is merged.

@stale
Copy link

stale bot commented Jan 17, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jan 17, 2022
@domdfcoding
Copy link
Owner

@dependabot recreate

@stale stale bot removed the stale label Feb 10, 2022
@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Feb 10, 2022

Superseded by #58.

@dependabot dependabot bot closed this Feb 10, 2022
@dependabot dependabot bot deleted the dependabot/pip/sphinx-gte-3.0.3-and-lt-4.2.0 branch February 10, 2022 09:50
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 failure: Linux The Linux tests are failing. failure: Windows The Windows tests are failing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant