Skip to content

docs: ignore warnings about missing external py xrefs #2904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 18, 2025
Merged

docs: ignore warnings about missing external py xrefs #2904

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93c654c
docs: ignore warnings about missing external py xrefs
rickeylev May 18, 2025
3ae4475
Merge branch 'main' into docs.ignore.py.external.xrefs
aignas May 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,12 @@
primary_domain = None # The default is 'py', which we don't make much use of
nitpicky = True

nitpick_ignore_regex = [
# External xrefs aren't setup: ignore missing xref warnings
# External xrefs to sphinx isn't setup: ignore missing xref warnings
("py:.*", "(sphinx|docutils|ast|enum|collections|typing_extensions).*"),
]

# --- Intersphinx configuration

intersphinx_mapping = {
Expand Down