Skip to content

fix:docs build errors #21286

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
Oct 13, 2025
Merged

fix:docs build errors #21286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56a059a
docs: add 'typing.Union' to nitpick_ignore_regex in Sphinx configuration
bhimrazy Oct 13, 2025
b1519b3
docs: add Supermicro link to linkcheck_ignore due to 403 error
bhimrazy Oct 13, 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
1 change: 1 addition & 0 deletions docs/source-fabric/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@

nitpick_ignore_regex = [
("py:class", "typing.Self"),
("py:data", "typing.Union"),
# these are not generated with docs API ref
("py:class", "lightning.fabric.utilities.types.Optimizable"),
("py:class", "lightning.fabric.utilities.types.Steppable"),
Expand Down
2 changes: 2 additions & 0 deletions docs/source-pytorch/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,7 @@ def _load_py_module(name: str, location: str) -> ModuleType:

nitpick_ignore = [
("py:class", "typing.Self"),
("py:data", "typing.Union"),
# missing in generated API
("py:exc", "MisconfigurationException"),
# TODO: generated list of all existing ATM, need to be fixed
Expand Down Expand Up @@ -648,6 +649,7 @@ def package_list_from_file(file):
"https://medium.com/pytorch-lightning/quick-contribution-guide-86d977171b3a",
"https://deepgenerativemodels.github.io/assets/slides/cs236_lecture11.pdf",
"https://developer.habana.ai", # returns 403 error but redirects to intel.com documentation
"https://www.supermicro.com", # returns 403 error
"https://www.intel.com/content/www/us/en/products/docs/processors/what-is-a-gpu.html",
"https://www.microsoft.com/en-us/research/blog/zero-infinity-and-deepspeed-unlocking-unprecedented-model-scale-for-deep-learning-training/", # noqa: E501
"https://stackoverflow.com/questions/66640705/how-can-i-install-grpcio-on-an-apple-m1-silicon-laptop",
Expand Down