DOC document autodoc native module stub environment variable - #14563
Open
Whning0513 wants to merge 6 commits into
Open
DOC document autodoc native module stub environment variable#14563Whning0513 wants to merge 6 commits into
Whning0513 wants to merge 6 commits into
Conversation
jdillard
reviewed
Jul 30, 2026
Author
|
The docs-lint warning is fixed in the latest commit by using literal markup for the custom environment variable. The current |
jdillard
approved these changes
Jul 31, 2026
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.
Addresses #14528.
Document the
SPHINX_AUTODOC_IGNORE_NATIVE_MODULE_TYPE_STUBSenvironment variable in the autodoc guide. The new section explains when it is useful for native extension modules and shows how to set it before runningsphinx-build.