Skip to content

fix: sphinx docs build error due to warnings #3306

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

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
+9 −0
Open

fix: sphinx docs build error due to warnings #3306

Changes from 11 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a96e489
docs: add nitpicky_ignore for typing.Union in Sphinx configuration
bhimrazy Nov 25, 2025
fd4d08f
add link ignore
bhimrazy Nov 28, 2025
47e5314
update
bhimrazy Nov 28, 2025
68f2746
add temp link ignore
bhimrazy Nov 28, 2025
2e7a624
update
bhimrazy Nov 28, 2025
0b8b5f9
fix typo
bhimrazy Nov 28, 2025
7917169
upd
bhimrazy Nov 28, 2025
b00e304
update
bhimrazy Nov 28, 2025
c2a9504
fix link check
bhimrazy Nov 28, 2025
b2118d6
remove extra comment
bhimrazy Nov 28, 2025
4891c46
try re-run
bhimrazy Dec 2, 2025
03916b4
refactor: remove unused PYPI_CACHE variable and update disk space cle…
bhimrazy Dec 3, 2025
e8058f2
fix: add missing UV_TORCH_BACKEND environment variable in docs build …
bhimrazy Dec 3, 2025
2c69340
fix spacing
bhimrazy Dec 3, 2025
2d929a5
try again without cache cleanup;
bhimrazy Dec 3, 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
8 changes: 8 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,11 @@ def _set_root_image_path(page_path: str) -> None:
}
nitpicky = True

nitpick_ignore = [
("py:class", "typing.Self"),
("py:data", "typing.Union"),
]

# -- Options for to-do extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
Expand Down Expand Up @@ -455,4 +460,7 @@ def linkcode_resolve(domain, info) -> Optional[str]: # noqa: ANN001
# todo: these links seems to be unstable, referring to .devcontainer
"https://code.visualstudio.com",
"https://code.visualstudio.com/.*",
# Ignore Medium articles which return 403 to automated clients
# Mean-Average-Precision (mAP) and Mean-Average-Recall (mAR)
"https://jonathan-hui.medium.com/map-mean-average-precision-for-object-detection-45c121a31173",
]
Loading