Remove dead notebook/gallery infrastructure from master#693
Merged
Conversation
- Delete: generate-notebooks.yml, docs/examples.rst, docs/generate_example_notebooks.py, jupytext.toml, run_examples.py, docs/Makefile - Remove nbsphinx extension and Colab prolog from docs/conf.py - Remove nbsphinx and jupytext from docs dependencies - Remove examples gallery from docs index toctree - Revert test_pages.yml to simple Sphinx build (no pandoc/notebooks) - Remove docs/_examples/ from .gitignore The notebook gallery approach was closed — proper documentation with static images will replace it. Legacy example notebooks untouched. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #693 +/- ##
=======================================
Coverage 74.40% 74.40%
=======================================
Files 56 56
Lines 8026 8026
Branches 1570 1570
=======================================
Hits 5972 5972
Misses 1437 1437
Partials 617 617
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Owner
Author
|
@Greptile-app |
…mples.py Both files referenced the deleted run_examples.py. Replace make/python commands with uv run equivalents. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Owner
Author
|
@Greptile-app |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The notebook gallery approach was closed — proper documentation with static images will replace it. Legacy example notebooks untouched.
Greptile Summary
This PR removes all the notebook/gallery infrastructure that was introduced to generate interactive Jupyter notebook documentation from the
examples/*.pyfiles. The approach has been abandoned in favour of static-image documentation, so all associated files, CI workflows, Sphinx extensions, and dependencies are cleanly deleted.generate-notebooks.yml,run_examples.py,docs/generate_example_notebooks.py,docs/examples.rst,docs/Makefile,Makefile,jupytext.tomldocs/conf.py:nbsphinxextension and Colab-badge prolog removedpyproject.toml:nbsphinx==0.9.7andjupytext==1.16.6dropped from the[docs]extratest_pages.yml: Simplified — pandoc install and notebook-generation steps removed; dependency installation delegated to thewaltsims/pagesaction via the newpyproject_toml_depsinputdocs/index.rst:examplestoctree entry removed alongside the now-deletedexamples.rst.gitignore:docs/_examples/rule removed (directory is no longer generated)No remaining references to the removed infrastructure exist in any build-critical file; the only mentions are in
plans/release-strategy.md, a planning document where the historical context is appropriate to retain.Confidence Score: 5/5
Safe to merge — purely a deletion of dead infrastructure with no impact on library functionality or existing tests.
All changes are deletions or straightforward removals of references. Every deleted file, extension, and dependency has been consistently removed across the workflow, Sphinx config, pyproject.toml, .gitignore, and index. No broken cross-references remain in build-critical files. No remaining findings rise above P2.
.github/workflows/test_pages.yml — uses a branch ref (waltsims/pages@pyproject.toml-support) rather than a pinned commit SHA, which is a pre-existing pattern not introduced by this PR.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD subgraph BEFORE["Before - Removed"] A[push to master] --> B[generate-notebooks.yml] B --> C[jupytext converts .py to .ipynb] C --> D[commit notebooks/ to master] E[push any branch] --> F[test_pages.yml - old] F --> G[install pandoc] G --> H[pip install docs deps] H --> I[generate_example_notebooks.py] I --> J[nbsphinx renders notebooks] J --> K[Sphinx build and deploy] end subgraph AFTER["After - This PR"] L[push any branch] --> M[test_pages.yml - new] M --> N[waltsims/pages action with pyproject_toml_deps] N --> O[Sphinx build and deploy - static RST/MD only] end style BEFORE fill:#ffeaea,stroke:#cc0000 style AFTER fill:#eaffea,stroke:#006600Comments Outside Diff (3)
run_examples.pyrun_examples.pyrun_examples.pyis deleted by this PR, but two places still reference it and will break:Root
Makefileline 20 — therun-examplestarget (and by extension the defaultalltarget) callspython run_examples.pydirectly. Anyone runningmake run-examplesormake allwill get a file-not-found error immediately after this merges.docs/development/development_environment.rstlines 98 & 104 — the development docs show users how to run examples with two explicit invocations ofrun_examples.py:Both references should be removed or updated to reflect whatever the new recommended way to run examples is (e.g., pointing users at the
examples/directory directly).Makefile, line 20 (link)make run-examplesnow broken —run_examples.pywas deletedrun_examples.pyis deleted in this PR, but the rootMakefile'srun-examplestarget (and thealltarget which depends on it) still callspython run_examples.py. Any developer runningmake run-examplesormake allwill hit aNo such file or directoryerror immediately.This Makefile target should either be removed or updated to invoke the examples via a different mechanism.
docs/development/development_environment.rst, line 96-104 (link)Docs reference deleted
run_examples.pyThe "Running Examples" section shows two commands that both rely on
run_examples.py, which is deleted in this PR:and
Both will fail with
No such file or directory. This section of the developer documentation should be updated or removed to reflect the new approach for running examples.Reviews (3): Last reviewed commit: "Merge master (readme cleanup already mer..." | Re-trigger Greptile