doc: Make API documentation great again

dependabot[bot] commented 3 weeks ago

Updates the requirements on griffe to permit the latest version.

Release notes

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! :rocket: :fire: :rainbow:

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

github-actions[bot] commented 3 days ago

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

github-actions[bot] commented 3 days ago

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

dependabot[bot] commented 2 days ago

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.