Avoid autogenerating docs for Python files with leading underscore#2397
Merged
Conversation
Signed-off-by: Tim Moon <tmoon@nvidia.com>
for more information, see https://pre-commit.ci
Signed-off-by: Tim Moon <tmoon@nvidia.com>
Collaborator
Author
|
Pipeline 38744752 is green. |
Contributor
Greptile Summary
Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as "Developer"
participant Sphinx as "Sphinx Doc Builder"
participant AutoAPI as "AutoAPI Extension"
participant FS as "File System"
Dev->>Sphinx: "Trigger doc build"
Sphinx->>AutoAPI: "Generate API docs"
AutoAPI->>FS: "Scan transformer_engine/"
FS-->>AutoAPI: "Return Python files"
AutoAPI->>AutoAPI: "Apply autoapi_ignore pattern */_[!_]*"
AutoAPI->>AutoAPI: "Exclude _test_dummy_feature.py, _common.py, etc"
AutoAPI->>AutoAPI: "Include __init__.py files"
AutoAPI->>Sphinx: "Generate docs for filtered files"
Sphinx-->>Dev: "Documentation built successfully"
|
Contributor
There was a problem hiding this comment.
1 file reviewed, no comments
Edit Code Review Agent Settings | Greptile
React with 👍 or 👎 to share your feedback on this new summary format
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.
Description
We've experienced CI failures due to hangs when generating docs, possibly because self imports in
transformer_engine/debug/features/_test_dummy_feature.pyare causing infinite recursion. This PR attempts to fix this issue by excluding this file from doc generation.#2301 is another attempt to fix problems with documentation, although I don't think it addresses anything with
_test_dummy_feature.py.Type of change
Changes
Checklist: