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,>=2.3 to >=2.3,<4 #23

Closed

Conversation

dependabot-preview[bot]
Copy link
Contributor

Updates the requirements on sphinx to permit the latest version.

Changelog

Sourced from sphinx's changelog.

Release 3.1.0 (released Jun 08, 2020)

Dependencies

  • #7746: mathjax: Update to 2.7.5

Incompatible changes

  • #7477: imgconverter: Invoke "magick convert" command by default on Windows

Deprecated

  • The first argument for sphinx.ext.autosummary.generate.AutosummaryRenderer has been changed to Sphinx object
  • sphinx.ext.autosummary.generate.AutosummaryRenderer takes an object type as an argument
  • The ignore argument of sphinx.ext.autodoc.Documenter.get_doc()
  • The template_dir argument of sphinx.ext.autosummary.generate. AutosummaryRenderer
  • The module argument of sphinx.ext.autosummary.generate. find_autosummary_in_docstring()
  • The builder argument of sphinx.ext.autosummary.generate. generate_autosummary_docs()
  • The template_dir argument of sphinx.ext.autosummary.generate. generate_autosummary_docs()
  • The ignore argument of sphinx.util.docstring.prepare_docstring()
  • sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()
  • sphinx.util.rpartition()

Features added

  • LaTeX: Make the toplevel_sectioning setting optional in LaTeX theme
  • LaTeX: Allow to override papersize and pointsize from LaTeX themes
  • LaTeX: Add :confval:latex_theme_options to override theme options
  • #7410: Allow to suppress "circular toctree references detected" warnings using :confval:suppress_warnings
  • C, added scope control directives, :rst:dir:c:namespace, :rst:dir:c:namespace-push, and :rst:dir:c:namespace-pop.
  • #2044: autodoc: Suppress default value for instance attributes
  • #7473: autodoc: consider a member public if docstring contains :meta public: in info-field-list
  • #7487: autodoc: Allow to generate docs for singledispatch functions by py:autofunction
  • #7143: autodoc: Support final classes and methods
  • #7384: autodoc: Support signatures defined by __new__(), metaclasses and
... (truncated)
Commits
  • 62a9b32 Bump to 3.1.0 final
  • 23a51a3 Merge pull request #7797 from tk0miya/7791_TypeError_for_singledispatchfunction
  • d0cdf07 Update CHANGES for PR #7657
  • 2ed2085 Merge pull request #7657 from mgeier/css-margins
  • 7fa47e4 Merge pull request #7788 from tk0miya/7722_support_typevar
  • bf89b1d Merge pull request #7794 from tk0miya/7792_setuptools_verbosity
  • 588e5bd Merge pull request #7778 from tk0miya/7723_pdflatex_URL_having_singlequote
  • f98987b Fix #7791: autodoc: TypeError is raised on documenting singledispatch function
  • 8bd5f8b autodoc: Support TypeVar (refs: #7722)
  • 6ccab6c Close #7792: setuptools: Support --verbosity option
  • 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.


Note: This repo was added to Dependabot recently, so you'll receive a maximum of 5 PRs for your first few update runs. Once an update run creates fewer than 5 PRs we'll remove that limit.

You can always request more updates by clicking Bump now in your Dependabot dashboard.

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 use these labels will set the current labels as the default for future PRs for this repo and language
  • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
  • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
  • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
  • @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

  • Update frequency (including time of day and day of week)
  • Pull request limits (per update run and/or open at any time)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

@dependabot-preview dependabot-preview bot added the dependencies Pull requests that update a dependency file label Jun 12, 2020
@espdev
Copy link
Owner

espdev commented Jun 12, 2020

m2r does not work with Sphinx 3.x
miyakogi/m2r#55

@espdev espdev closed this Jun 12, 2020
@dependabot-preview
Copy link
Contributor Author

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

@dependabot-preview dependabot-preview bot deleted the dependabot/pip/sphinx-gte-2.3-and-lt-4 branch June 12, 2020 17: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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant