docs: overhaul nitpick-ignore rules and fix broken cross-references - #46
Closed
AVHopp wants to merge 2 commits into
Closed
docs: overhaul nitpick-ignore rules and fix broken cross-references#46AVHopp wants to merge 2 commits into
AVHopp wants to merge 2 commits into
Conversation
Replace the catch-all nitpick_ignore_regex (which suppressed every non-baybe reference and thereby also hid broken internal cross-refs) with targeted, categorized ignore patterns. Fix the internal references, admonition, and docstrings this exposed, and suppress the unavoidable forward-reference/guarded-import warnings from lazy-loaded heavy deps.
Fix pre-existing issues surfaced by the nitpicky (`-n -W`) build that the strict nitpick rules newly expose: - Change the `MeanFactoryProtocol` cross-reference in the GP surrogate docstring from `:class:` to `:obj:`. The runtime type alias only exposes a `py:obj` target, so the `:class:` role failed to resolve. - Drop the invalid `:hidden:` option from the `autosummary` directive in `docs/index.md`, which raised "unknown option: hidden". - Add the `GPyTorchKernel` and `GPyTorchMean` TYPE_CHECKING-only aliases to the nitpick-ignore list alongside their sibling `GPyTorchLikelihood`. All three appear in `GaussianProcessSurrogate.from_preset`'s signature and cannot be resolved by Sphinx. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
AVHopp
force-pushed
the
docs/fix-doc-references
branch
from
August 17, 2026 13:42
00a5924 to
651d4a5
Compare
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
1 participant
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.
Layer 1 of a 4-PR stack decoupling linkcheck from the docs pipeline (rebased onto latest main).
Replaces the catch-all
nitpick_ignore_regex(which suppressed every non-baybe reference, and thereby also hid broken internal cross-refs) with targeted, categorized ignore patterns, and fixes the internal references, admonition, and docstrings this exposed. Also suppresses the unavoidable forward-reference/guarded-import warnings from lazy-loaded heavy deps.Stack (bottom → top):
main)