docs: Add support for class methods in API reference #7841
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
This pull request adds support for class methods in the api documentation by replacing calls to
inspect.isfunction()
with the more inclusiveinspect.isroutine()
. In particular, theImage
,Prediction
andSignature
primitives have several relevant functions that were not being captured by the previous method.It also excludes functions defined by external modules (e.g. Pydantic), but it seems there is some other mechanism that also filters them out somewhere, since they do not appear in the existing documentation despite being present in the generated markdown.
Before
After