Skip to content

DOC document autodoc native module stub environment variable - #14563

Open
Whning0513 wants to merge 6 commits into
sphinx-doc:masterfrom
Whning0513:docs/document-autodoc-stub-envvar-14528
Open

DOC document autodoc native module stub environment variable#14563
Whning0513 wants to merge 6 commits into
sphinx-doc:masterfrom
Whning0513:docs/document-autodoc-stub-envvar-14528

Conversation

@Whning0513

Copy link
Copy Markdown

Addresses #14528.

Document the SPHINX_AUTODOC_IGNORE_NATIVE_MODULE_TYPE_STUBS environment variable in the autodoc guide. The new section explains when it is useful for native extension modules and shows how to set it before running sphinx-build.

Copilot AI review requested due to automatic review settings July 30, 2026 11:56

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Comment thread doc/usage/extensions/autodoc.rst Outdated
@jdillard jdillard added awaiting:response Waiting for a response from the author of this issue type:docs labels Jul 30, 2026
@Whning0513

Copy link
Copy Markdown
Author

The docs-lint warning is fixed in the latest commit by using literal markup for the custom environment variable. The current ty failure still reports the same broad set of diagnostics across existing test fixtures (335 in total), including the unrelated test_ext_intersphinx and other test modules, so it appears independent of this documentation change.

@jdillard jdillard removed the awaiting:response Waiting for a response from the author of this issue label Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Autodoc: Document SPHINX_AUTODOC_IGNORE_NATIVE_MODULE_TYPE_STUBS variable added in v9.1.0

3 participants