fix: remove legacy Jupyter Book config and clean stale nav refs#264
fix: remove legacy Jupyter Book config and clean stale nav refs#264joamatab wants to merge 1 commit into
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideRemoves 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
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)
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)
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.
Summary
_toc.ymland_config.yml(docs now use zensical)zensical.tomlnav entries pointing to deleted stub filesmkdocs-pdf.ymlnav entries pointing to deleted stub filesTest plan
Summary by Sourcery
Documentation:
_config.ymland_toc.ymldocumentation config files tied to the previous Jupyter Book setup.