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

doc: Make API documentation great again #797

Merged
merged 15 commits into from
Sep 11, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Aug 20, 2024

Updates the requirements on griffe to permit the latest version.

Release notes

Sourced from griffe's releases.

1.1.0

1.1.0 - 2024-08-17

Compare with 1.0.0

Features

  • Add on_wildcard_expansion event (c6bc6fa by Timothée Mazzucotelli). Issue-282
  • Add on_alias event (a760a8c by Timothée Mazzucotelli). Issue-282
  • Pass loader to on_package_loaded hooks (7f82dc3 by Timothée Mazzucotelli).
Changelog

Sourced from griffe's changelog.

1.1.0 - 2024-08-17

Compare with 1.0.0

Features

  • Add on_wildcard_expansion event (c6bc6fa by Timothée Mazzucotelli). Issue-282
  • Add on_alias event (a760a8c by Timothée Mazzucotelli). Issue-282
  • Pass loader to on_package_loaded hooks (7f82dc3 by Timothée Mazzucotelli).

1.0.0 - 2024-08-15

Compare with 0.49.0

V1! 🚀 🔥 🌈

Breaking changes

Highlights:

  • Extensions inherit from Extension, (VisitorExtension and InspectorExtension are removed)
  • Members are serialized (as_dict/JSON) as a dictionary instead of a list
  • All objects are available in the top-level griffe module, nowhere else

Removed objects:

  • all modules under the griffe package
  • the griffe.DocstringWarningCallable class
  • the griffe.When class
  • the griffe.ExtensionType type
  • the griffe.InspectorExtension class
  • the griffe.VisitorExtension class
  • the griffe.HybridExtension extension
  • the griffe.patch_logger function
  • the griffe.JSONEncoder.docstring_parser attribute
  • the griffe.JSONEncoder.docstring_options attribute
  • the griffe.Extensions.attach_visitor method
  • the griffe.Extensions.attach_inspector method
  • the griffe.Extensions.before_visit method
  • the griffe.Extensions.before_children_visit method
  • the griffe.Extensions.after_children_visit method
  • the griffe.Extensions.after_visit method
  • the griffe.Extensions.before_inspection method
  • the griffe.Extensions.before_children_inspection method
  • the griffe.Extensions.after_children_inspection method
  • the griffe.Extensions.after_inspection method
  • the griffe.GriffeLoader.load_module method
  • the has_special_name and has_private_name properties on objects
  • the is_explicitely_exported and is_implicitely_exported properties on objects
  • the member_is_exported method on objects

... (truncated)

Commits
  • bfa306e chore: Prepare release 1.1.0
  • c6bc6fa feat: Add on_wildcard_expansion event
  • a760a8c feat: Add on_alias event
  • 7f82dc3 feat: Pass loader to on_package_loaded hooks
  • b72eae8 ci: Ignore Mypy warning
  • 51c26ca docs: Add missing documentation for parameters of extension hooks
  • 8c630d5 docs: Add griffe-runtime-objects extension to the docs
  • 35058bf docs: List griffe-autodocstringstyle extension
  • 5a24ed8 style: Format
  • d0ab96a chore: Clean up imports
  • 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 <dependency name> 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)

update griffe requirement from <1.0.0,>=0.46 to >=0.46,<2.0.0

Updates the requirements on [griffe](https://github.com/mkdocstrings/griffe) to permit the latest version.
- [Release notes](https://github.com/mkdocstrings/griffe/releases)
- [Changelog](https://github.com/mkdocstrings/griffe/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/griffe@0.46.0...1.1.0)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies PR related to ANTA dependencies label Aug 20, 2024
Copy link
Contributor

@carl-baillargeon carl-baillargeon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update code to support Griffe v1.

@gmuloc gmuloc self-assigned this Aug 30, 2024
Copy link
Contributor

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Copy link
Contributor

Conflicts have been resolved. A maintainer will review the pull request shortly.

pyproject.toml Outdated Show resolved Hide resolved
anta/catalog.py Outdated Show resolved Hide resolved
anta/catalog.py Outdated Show resolved Hide resolved
anta/catalog.py Outdated Show resolved Hide resolved
anta/catalog.py Outdated Show resolved Hide resolved
anta/catalog.py Outdated Show resolved Hide resolved
anta/models.py Outdated Show resolved Hide resolved
Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 11, 2024

A newer version of griffe 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.

pyproject.toml Show resolved Hide resolved
@gmuloc gmuloc changed the title chore: update griffe requirement from <1.0.0,>=0.46 to >=0.46,<2.0.0 doc: Make documentation great again Sep 11, 2024
Copy link
Contributor

@carl-baillargeon carl-baillargeon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link

@gmuloc gmuloc changed the title doc: Make documentation great again doc: Make API documentation great again Sep 11, 2024
@gmuloc gmuloc merged commit e32821d into main Sep 11, 2024
28 checks passed
@dependabot dependabot bot deleted the dependabot/pip/griffe-gte-0.46-and-lt-2.0.0 branch September 11, 2024 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies PR related to ANTA dependencies rn: doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants