docs: Add inherited methods to API reference documentation #5273
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
Pull Request Test Coverage Report for Build 5456810715
💛 - Coveralls |
anakin87
reviewed
Jul 5, 2023
Member
anakin87
left a comment
anakin87
left a comment
There was a problem hiding this comment.
In general, this PR looks good to me. 👍
Let's just figure out if we want to use this opportunity to hide abstract classes/methods and avoid duplication...
Contributor
Author
I would tackle this in a separate PR. |
Contributor
Author
|
Let's wait until @dfokina is back to get her view on this topic. |
bogdankostic
added
the
ignore-for-release-notes
# Conflicts: # docs/pydoc/config/document-store.yml # haystack/preview/pipeline.py
… into inherited_methods_api_reference # Conflicts: # docs/pydoc/config/document-store.yml
Contributor
Author
|
This is how the DocumentStore API docs would look like if we would merge this PR now: document_store_api.md |
DosticJelena
pushed a commit
to smartcat-labs/haystack
that referenced
this pull request
Aug 23, 2023
…i#5273) * Add inherited methods to API reference documentation * Fix typing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related Issues
Proposed Changes:
This PR adds the custom loader
CustomPythonLoaderforpydoc-markdownand sets it as the loader for all documentation config files.CustomPythonLoaderextendsPythonLoaderin such a way that the loaded classes not only contain the methods that are directly defined in them, but also their inherited methods from parent classes. The inherited methods are added recursively to make sure to display methods from all inheritance levels, not just direct inheritance.As an example, here is the generated file for DocumentStore API docs: document_store_api.md
How did you test it?
I manually ran the
pydoc-markdown.shscript.Notes for the reviewer
There was a formatting error in
Pipeline.rundocstring, so I needed to fix that.Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.