Fix docstring formatting for sphinx-autoapi compatibility #153
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
- Add docstrings to SimInterface and Data TypedDict classes to override inherited dict docstrings that cause RST parsing errors - Fix IOModelOptions Attributes section formatting with consistent line lengths and proper RST inline literal syntax (double backticks) - Fix submodule_metadata docstring to use double backticks for inline literals and proper Args/Yields format - Fix Sky130Port docstring with proper RST link syntax and spacing These changes resolve RST errors and warnings generated by sphinx-autoapi when building documentation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
|
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.
Summary
SimInterfaceandDataTypedDict classes to override inherited dict docstrings that cause RST parsing errorsIOModelOptionsAttributes section formatting with consistent line lengths and proper RST inline literal syntax (double backticks)submodule_metadatadocstring to use double backticks for inline literals and proper Args/Yields formatSky130Portdocstring with proper RST link syntax and spacingContext
When building documentation with sphinx-autoapi, TypedDict classes without explicit docstrings inherit Python's built-in
dictdocstring, which contains indentation that RST interprets as unexpected block quotes, causing 4 ERRORS.Additionally, several docstrings had issues with:
Test plan
pdm run docsin chipflow-docs🤖 Generated with Claude Code