Make sure __init__ functions are displayed in docs #477
Conversation
This file contains 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
By default autodocs only show class docstrings and hide __init__ https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autoclass_content https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options Make sure docstrings added to __init__ functions show up in the docs
jparise
approved these changes
Feb 3, 2023
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.
By default autodocs only show class docstrings and hide init https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autoclass_content https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options
Make sure docstrings added to init functions show up in the docs
Closes #473