search

catalyst-cooperative / ferc-xbrl-extractor

A tool for converting FERC filings published in XBRL into SQLite databases
MIT License
11 stars 1 forks source link

Update sphinx-autoapi requirement from <3.1,>=3.0 to >=3.0,<3.2 #228

Closed dependabot[bot] closed 3 months ago

dependabot[bot] commented 3 months ago

Updates the requirements on sphinx-autoapi to permit the latest version.

Release notes

Sourced from sphinx-autoapi's releases.

v3.1.1

Bugfixes

  • Fix private subpackages causing orphan pages (#446)
Changelog

Sourced from sphinx-autoapi's changelog.

v3.1.1 (2024-05-22)

Bugfixes ^^^^^^^^

  • Fix private subpackages causing orphan pages (#446)

v3.1.0 (2024-05-20)

Features ^^^^^^^^

  • Objects can render to their own page (#226)
  • Render PEP-695 type aliases as TypeAlias assignments. (#414)

Bugfixes ^^^^^^^^

  • Values are always rendered for TypeAlises and PEP-695 type aliases. (#224)
  • Fix submodule with __init__.pyi documented as __init__ instead of submodule name (#398)
  • Fix IndexError when a module docstring contains only a heading (#412)
  • Preserve strings inside Literal type annotations (#423)
  • Stopped using xrefs in page titles (#427)
  • Fix unpickable configuration value warning when using autoapi_prepare_jinja_env (#445)
  • Fix emitting ignore event twice for methods.

Misc ^^^^

v3.0.0 (2023-09-26)

Bugfixes ^^^^^^^^

  • Ensure tooltip is always a str. (str-tooltip)
  • Replaced usage of deprecated sphinx.util.status_iterator (#391)

Deprecations and Removals ^^^^^^^^^^^^^^^^^^^^^^^^^

... (truncated)

Commits
  • 8001fbd Version 3.1.1
  • eecb6e8 Fix private subpackages causing orphan pages
  • d45f2ed Start testing in Python 3.13
  • 7b10bb2 Fix distribution signing failing due to importerror
  • bf2ff28 Version 3.1.0
  • 4ff4116 Fix unpickable configuration value when using autoapi_prepare_jinja_env
  • f23b079 Stop using xrefs in page titles
  • 3b037c7 Moved bugfix announcement into a separate news item
  • bc71226 Render PEP-695 type aliases as TypeAlias assignments
  • 007077a Refactor mapper classes into their bases
  • 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.

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 show ignore conditions` will show all of the ignore conditions of the specified dependency - `@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)
zaneselvans commented 3 months ago

There's a bug in Sphinx AutoAPI 3.1.0/3.1.1. Pin to avoid it.

See https://github.com/readthedocs/sphinx-autoapi/issues/452

dependabot[bot] commented 3 months ago

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. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

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