Skip to content

fix: remove legacy Jupyter Book config and clean stale nav refs#264

Open
joamatab wants to merge 1 commit into
mainfrom
fix/cleanup-deleted-refs
Open

fix: remove legacy Jupyter Book config and clean stale nav refs#264
joamatab wants to merge 1 commit into
mainfrom
fix/cleanup-deleted-refs

Conversation

@joamatab
Copy link
Copy Markdown
Contributor

@joamatab joamatab commented May 22, 2026

Summary

  • Delete legacy _toc.yml and _config.yml (docs now use zensical)
  • Remove zensical.toml nav entries pointing to deleted stub files
  • Remove mkdocs-pdf.yml nav entries pointing to deleted stub files

Test plan

  • Verify docs build succeeds

Summary by Sourcery

Documentation:

  • Delete obsolete _config.yml and _toc.yml documentation config files tied to the previous Jupyter Book setup.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 22, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Removes legacy Jupyter Book configuration files now that docs use zensical, and cleans up navigation entries referencing deleted content in the docs configuration.

File-Level Changes

Change Details Files
Remove legacy Jupyter Book configuration now superseded by zensical-based setup.
  • Delete obsolete Jupyter Book site configuration file
  • Delete obsolete Jupyter Book table-of-contents configuration file
docs/_config.yml
docs/_toc.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request removes the Jupyter Book configuration files _config.yml and _toc.yml, likely as part of a migration to a different documentation framework. The review feedback highlights that several changes mentioned in the pull request description are missing from the diff. Furthermore, the reviewer advises migrating important configurations—such as type aliases, notebook execution error handling, and simulation notebook entries—to the new documentation setup to prevent regressions in documentation quality and completeness.

I am having trouble creating individual review comments. Click here to see my feedback.

docs/_toc.yml (1-16)

high

The pull request description mentions cleaning up navigation entries in mkdocs-pdf.yml and zensical.toml, but these changes are missing from the diff. Additionally, the Simulations notebooks (lines 13-16) are being removed from the table of contents here but are not present in the mkdocs-pdf.yml navigation provided in the repository files. If these notebooks are still relevant and not 'stale', they should be migrated to the new documentation configuration.

docs/_config.yml (47-70)

medium

These autodoc_type_aliases and the nb_execution_raise_on_error setting are important for documentation quality and build integrity. Since this file is being deleted, ensure these configurations are migrated to the new MkDocs/mkdocstrings setup (e.g., using import_map for aliases and the appropriate build-on-error flags) to avoid regressions in documentation readability and reliability.

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.

1 participant