Skip to content

Fix doc references - #890

Merged
AVHopp merged 0 commit into
docs/separate_linkcheckfrom
docs/fix_doc_references
Aug 18, 2026
Merged

Fix doc references#890
AVHopp merged 0 commit into
docs/separate_linkcheckfrom
docs/fix_doc_references

Conversation

@AVHopp

@AVHopp AVHopp commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

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 CLIGive Feedback 💬

Copilot AI lite review requested due to automatic review settings August 18, 2026 08:38
@AVHopp
AVHopp force-pushed the docs/fix_doc_references branch from f1b3953 to cfa3e33 Compare August 18, 2026 08:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md into a dedicated docs/api_reference.md page.
  • Expand and reorganize nitpick_ignore_regex and suppress_warnings in docs/conf.py to handle more external/inherited/unresolvable references now that non-baybe links 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 thread docs/conf.py
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
AVHopp force-pushed the docs/fix_doc_references branch 2 times, most recently from 8f5e6c7 to 9739fdc Compare August 18, 2026 11:13
@AVHopp
AVHopp force-pushed the docs/fix_doc_references branch from 9739fdc to 057e630 Compare August 18, 2026 11:30
@AVHopp
AVHopp force-pushed the docs/fix_doc_references branch 3 times, most recently from f5a7674 to 0993fa5 Compare August 18, 2026 13:48
@AVHopp
AVHopp force-pushed the docs/fix_doc_references branch from 0993fa5 to 25d3e46 Compare August 18, 2026 14:42
@AVHopp
AVHopp merged commit 25d3e46 into main Aug 18, 2026
1 check failed
@AVHopp
AVHopp deleted the docs/fix_doc_references branch August 18, 2026 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants