add members to automodule for Sphinx to pickup docstrings #576
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
…the auto documentation
|
Finally! Thank you!! |
da110us
approved these changes
Oct 8, 2024
jamesholland-uk
approved these changes
Oct 14, 2024
Member
jamesholland-uk
left a comment
jamesholland-uk
left a comment
There was a problem hiding this comment.
Looks like @DctrG tested the changes locally, and the changes only touch the documentation which is already broken so the risk in this change is low, with the goal of fixing this part of the docs.
|
🎉 This PR is included in version 1.12.2 🎉 The release is available on PyPI and GitHub release
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
Added ":members:" to module-*.rst files.
Motivation and Context
The current documentation is missing the docstrings from the classes in the modules, it shows only the docstring from the module itself which is not useful for the module users.
How Has This Been Tested?
I run "make docs" for Sphinx to crate the docs and verified that the docstrings are now populated.
Screenshots (if appropriate)
This is what the current documentation shows:
This is what it will show with the changes:
Types of changes
Checklist