Fix doc references - #890
Merged
Merged
Conversation
AVHopp
force-pushed
the
docs/fix_doc_references
branch
from
August 18, 2026 08:45
f1b3953 to
cfa3e33
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Sphinx/doc cross-references and refines documentation build/link-check behavior so that internal (relative) references are no longer implicitly ignored, while adding targeted suppressions for external/unresolvable references. It also moves recursive autosummary stub generation off the documentation landing page.
Changes:
- Restructure API reference generation by moving the recursive autosummary directive from
docs/index.mdinto a dedicateddocs/api_reference.mdpage. - Expand and reorganize
nitpick_ignore_regexandsuppress_warningsindocs/conf.pyto handle more external/inherited/unresolvable references now that non-baybelinks are no longer blanket-ignored. - Fix/adjust several doc references and directive options in both docs and docstrings.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/templates/custom-module-template.rst | Adjust autosummary module listing to skip kmedoids. |
| docs/index.md | Remove recursive autosummary directive from the landing page; keep API reference pointing to generated autosummary tree. |
| docs/conf.py | Replace blanket nitpick ignore with categorized ignore regexes; expand suppressed warning categories. |
| docs/components/transformations.md | Fix MyST admonition option syntax (:class: note). |
| docs/api_reference.md | New page to trigger recursive autosummary stub generation without rendering the module summary table on index.md. |
| baybe/transformations/base.py | Fix/fully qualify docstring cross-references to Transformation. |
| baybe/surrogates/gaussian_process/core.py | Fix cross-reference role for MeanFactoryProtocol to match its nature (object/type alias). |
| baybe/recommenders/meta/base.py | Fully qualify a method cross-reference in docstring. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+156
to
+159
| ( | ||
| r"py:.*", | ||
| r"(pandas|numpy|torch|botorch|gpytorch|scipy|sklearn|pathlib|polars|attr|joblib|matplotlib|skfp|rdkit|shap|xyzpy|typing)[\._].*", | ||
| ), # noqa: E501 |
AVHopp
force-pushed
the
docs/fix_doc_references
branch
2 times, most recently
from
August 18, 2026 11:13
8f5e6c7 to
9739fdc
Compare
AVHopp
force-pushed
the
docs/fix_doc_references
branch
from
August 18, 2026 11:30
9739fdc to
057e630
Compare
AVHopp
force-pushed
the
docs/fix_doc_references
branch
3 times, most recently
from
August 18, 2026 13:48
f5a7674 to
0993fa5
Compare
AdrianSosic
approved these changes
Aug 18, 2026
AVHopp
force-pushed
the
docs/fix_doc_references
branch
from
August 18, 2026 14:42
0993fa5 to
25d3e46
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
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.
This PR fixes incorrect doc references and makes some general changes to how we check our internal links.
The core issue that is fixed here is that we previously ignored all links that do not contain or start with
baybe. As a consequence, internal relative links were being skipped, and if those links were broken, we simply didn't know. This was now removed. As a consequence, we however now need to manually add a lot of additional regexes that we need to ignore now. I still need to investigate if all of these are actually necessary, so this list it self might still change.Note that this PR does not yet solve the issue related to the warnings being emitted after the first PR, so it is expected that this still fails.
Stack created with GitHub Stacks CLI • Give Feedback 💬