Skip to content

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

Merged
Alex-l-r merged 3 commits into
mainfrom
fix/cleanup-deleted-refs
May 26, 2026
Merged

fix: remove legacy Jupyter Book config and clean stale nav refs#171
Alex-l-r merged 3 commits 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

Build:

  • Delete obsolete docs/_config.yml and docs/_toc.yml Jupyter Book configuration files.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 22, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR removes legacy Jupyter Book configuration files now superseded by zensical-based docs configuration, and is expected to be accompanied by cleanup of stale navigation references in zensical and mkdocs configs.

File-Level Changes

Change Details Files
Remove obsolete Jupyter Book configuration now that docs are managed by zensical
  • Delete legacy Jupyter Book site configuration file
  • Delete legacy 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
Contributor

@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 and table of contents files, signaling a transition to a new documentation system. Feedback focuses on ensuring a complete migration: the README should be updated to reflect the change, and critical settings—such as type aliases, API documentation layouts, and CI safety checks—need to be ported over. Additionally, the reviewer noted that several core pages and demo sections currently lack counterparts in the new navigation structure, which could lead to inaccessible content.

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

docs/_config.yml (1)

medium

The removal of the Jupyter Book configuration is consistent with the transition to zensical/mkdocs. However, the README.md (line 107) still describes the docs/ directory as "Jupyter Book documentation (Sphinx)". This description should be updated to reflect the new documentation system to maintain accuracy for contributors.

docs/_config.yml (49-75)

medium

Several important documentation settings are being removed without apparent counterparts in the new configuration. Specifically, autodoc_type_aliases (lines 52-74) are essential for readable type hints, autodoc_typehints: description (line 49) controls the layout of API docs, and nb_execution_raise_on_error: true (line 75) is a critical CI safety check. These should be migrated to the mkdocstrings and notebook execution settings in the new system to maintain documentation quality and build reliability.

docs/_toc.yml (8-23)

medium

The removal of these navigation entries makes several core pages (tech, cells_fixed, cells2_reference), the entire "Demos" section, and external links (gplugins, gdsfactory) inaccessible. If these are not actually stale stubs, they should be migrated to the new navigation configuration. Note that the execution exclusion for palace_demo_cpw (previously in _config.yml line 14) also needs to be carried over to the new system to prevent potential build issues.

@Alex-l-r Alex-l-r merged commit dc5122f into main May 26, 2026
8 checks passed
@Alex-l-r Alex-l-r deleted the fix/cleanup-deleted-refs branch May 26, 2026 05:50
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.

2 participants