fix: include __init__ docstrings in Sphinx documentation output (Fixes #1144)#1163
Open
rtmalikian wants to merge 1 commit into
Open
fix: include __init__ docstrings in Sphinx documentation output (Fixes #1144)#1163rtmalikian wants to merge 1 commit into
rtmalikian wants to merge 1 commit into
Conversation
Set autoclass_content to 'both' so Sphinx renders both the class-level and __init__ docstrings. Also enable napoleon_include_init_with_doc so Napoleon-flavoured init docs appear in the generated HTML. Fixes sunlabuiuc#1144 Signed-off-by: rtmalikian <rtmalikian@gmail.com>
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
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.
Fixes #1144
Problem
The current Sphinx documentation configuration excludes
__init__docstrings from the generated HTML output. This means important constructor parameter documentation is missing from the ReadTheDocs pages.For example,
ChestXray14Dataset's__init__docstring documents thetablesparameter, but it doesn't appear in the generated docs.Root Cause
Two settings in
docs/conf.pyprevent__init__docstrings from appearing:autoclass_contentdefaults to"class"— only the class-level docstring is includednapoleon_include_init_with_doc = False— Napoleon explicitly excludes__init__docsSolution
autoclass_content = "both"so Sphinx renders both the class-level and__init__docstringsnapoleon_include_init_with_docfromFalsetoTrueso Napoleon-flavoured init docs appear in the generated HTMLTesting
The fix can be verified by building the docs locally:
Or by checking that
__init__parameter docs now appear in class pages on ReadTheDocs after merge.Changelog
Files Changed
autoclass_content = "both", changednapoleon_include_init_with_doctoTrueAbout the Author: Raphael Malikian — Clinical AI Solutions Architect. I specialise in building and fixing AI/ML systems for healthcare, including vector databases, RAG pipelines, and clinical NLP. If you need help with your project or think I can add value to your organisation, feel free to reach out — I'd love to connect.
📧 rtmalikian@gmail.com
🔗 GitHub: https://github.com/rtmalikian
🔗 LinkedIn: http://www.linkedin.com/in/raphael-t-malikian-mbbs-bsc-hons-71075436a
Disclosure: This code was developed with assistance from mimo-v2.5-pro (Xiaomi) via Hermes Agent (Nous Research). All changes were reviewed, tested against the actual codebase, and verified for correctness.