[py] Skip devtools when generating Python API docs #15918
Merged
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.
User description
💥 What does this PR do?
This PR updates the API generation script so it doesn't auto-generate API docs for devtools modules if they exist.
This also updates the link to latest documentation on readthedocs.io.
🔄 Types of changes
PR Type
Documentation
Description
• Skip devtools modules from Python API documentation generation
• Update ReadTheDocs link formatting with proper hyperlink syntax
Changes walkthrough 📝
generate_api_module_listing.py
Filter devtools from API generation
py/generate_api_module_listing.py
• Filter out devtools modules from API documentation generation
•
Optimize base_modules list comprehension with set comprehension
• Add
blank line for code formatting
index.rst
Update ReadTheDocs link formatting
py/docs/source/index.rst
• Convert ReadTheDocs URL to proper reStructuredText hyperlink format
• Update documentation link to use latest version endpoint