Skip to content

Work on Docs to remove warnings.#495

Merged
mmschlk merged 24 commits intomainfrom
docs-fix-warnings
Mar 28, 2026
Merged

Work on Docs to remove warnings.#495
mmschlk merged 24 commits intomainfrom
docs-fix-warnings

Conversation

@mmschlk
Copy link
Copy Markdown
Owner

@mmschlk mmschlk commented Mar 10, 2026

Motivation and Context

I wanted to remove all warnings for the docs building process and clean up the existing docstrings to come to a clean slate state in terms of documentation. Adaptions and changes can now be made more easily and should be of a much higher quality. Looking forward to more improvements here. :)

Important: We now have a CI test to break on any docs issues. ❤️


Public API Changes

  • No Public API changes
  • Yes, Public API changes (Details below)

How Has This Been Tested

Extensively in CI and locally.

mmschlk and others added 3 commits March 9, 2026 17:41
Setting autosectionlabel_prefix_document = True prefixes every
auto-generated section label with its document path, preventing
collisions when multiple notebooks share identical headings like
"General Use" or "Feature Names".

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Three root causes resolved:

- language_model_game.ipynb was doubly-wrapped: the file contained a
  single raw cell whose source was the entire notebook JSON. Unwrapped
  to the correct 31-cell notebook, fixing 129 repeated toc.no_title
  warnings (nbsphinx fired once per output page because no title was
  visible).

- Deleted orphaned api/shapiq.imputer.conditional_imputer.rst which
  referenced a module that no longer exists, causing an autodoc import
  failure and a "document not in toctree" warning.

- Added examples/GALLERY_HEADER.rst to exclude_patterns so sphinx-
  gallery's header file does not produce a "document not in toctree"
  warning (sphinx-gallery includes it internally via auto_examples/).

The docs now build with -W --keep-going without any warnings.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

mmschlk added 15 commits March 10, 2026 11:29
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
# Conflicts:
#	src/shapiq/tree/base.py
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
@mmschlk mmschlk requested a review from Advueu963 March 16, 2026 14:18
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Copy link
Copy Markdown
Collaborator

@Advueu963 Advueu963 left a comment

Choose a reason for hiding this comment

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

Noice changes! Can we quickly talk about this .md file that exists here. Should it be removed?

mmschlk added 5 commits March 19, 2026 20:14
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
Signed-off-by: Maximilian <maximilian.muschalik@gmail.com>
@mmschlk mmschlk merged commit 2ccfeb5 into main Mar 28, 2026
14 checks passed
@mmschlk mmschlk deleted the docs-fix-warnings branch March 28, 2026 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants