Skip to content

Conversation

@dependabot-preview
Copy link
Contributor

Bumps sphinx-autoapi from 1.5.1 to 1.6.0.

Changelog

Sourced from sphinx-autoapi's changelog.

V1.6.0 (2021-01-20)

Breaking Changes

  • Dropped support for Python 2 and Sphinx 1.x/2.x. Python 2 source code can still be parsed.

Features

  • Added support for using type hints as parameter types and return types via the sphinx.ext.autodoc.typehints extension.
  • `#191 <readthedocs/sphinx-autoapi#191>: Basic incremental build support is enabled autoapi_keep_files` is enabled. Providing none of the source files have changed, AutoAPI will skip parsing the source code and regenerating the API documentation.
  • `#200 <readthedocs/sphinx-autoapi#200>`: Can pass a callback that edits the Jinja Environment object before template rendering begins. This allows custom filters, tests, and globals to be added to the environment.
  • Added support for Python 3.9.

Bug Fixes

  • `#246 <readthedocs/sphinx-autoapi#246>: Fixed TypeError when parsing a class that inherits from type`.
  • `#244 <readthedocs/sphinx-autoapi#244>`: Fixed an unnecessary deprecation warning being raised when running sphinx-build from the same directory as conf.py.
  • Fixed properties documented by Autodoc directives geting documented as methods.
Commits
  • 731323c Version 1.6.0
  • 714c060 Added Python 3.9 support
  • a8d07b6 Can edit the Jinja environment
  • 06a1969 Fixed autodoc directives documenting properties as methods
  • e281137 Fixed raising unnecessary deprecation warning
  • 78b7958 Implmented basic incremental building
  • 6a6f7a9 Added CHANGELOG entry
  • 5ee7dbe Correctly parse Metaclasses
  • 7330297 Fixed tests on Python <3.8
  • 31d4beb Readthedocs uses Python 3.8
  • Additional commits viewable in compare view

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 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 Jan 21, 2021
@codecov
Copy link

codecov bot commented Jan 21, 2021

Codecov Report

Merging #179 (30ead18) into master (343ed93) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #179   +/-   ##
=======================================
  Coverage   90.54%   90.54%           
=======================================
  Files          40       40           
  Lines        1745     1745           
  Branches      277      277           
=======================================
  Hits         1580     1580           
  Misses        110      110           
  Partials       55       55           
Flag Coverage Δ
unittests 90.54% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


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 343ed93...30ead18. Read the comment docs.

@jtc42 jtc42 merged commit f0bcca0 into master Jan 21, 2021
@dependabot-preview dependabot-preview bot deleted the dependabot/pip/sphinx-autoapi-1.6.0 branch January 21, 2021 09:15
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