Migrate grid documentation to jupyter books#301
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates Grid’s documentation site from the existing Sphinx/RST setup under doc/ to a Jupyter Book site under website/, updates the GitHub Pages deployment workflow accordingly, and does a couple of small docstring/notebook touch-ups to support the new docs.
Changes:
- Add Jupyter Book configuration/content under
website/(intro, installation, conventions, tables, and user-doc pages). - Replace the old
doc/Sphinx site sources and notebook link plumbing (.nblink) by deleting the old RST-based site inputs. - Update the GitHub Actions workflow to build Jupyter Book + auto-generate API docs into the book before publishing.
Reviewed changes
Copilot reviewed 39 out of 46 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| website/requirements.txt | Adds Jupyter Book build requirements for the new website pipeline. |
| website/references.bib | Adds bibliography placeholder used by Jupyter Book config. |
| website/radial_transf.ipynb | New Jupyter Book page for radial transformations (markdown-only notebook). |
| website/onedgrids.ipynb | New Jupyter Book page for one-dimensional grids (markdown-only notebook). |
| website/intro.md | New landing page for the Jupyter Book site (replaces old doc/index.rst). |
| website/installation.ipynb | New installation/build-docs page for the book. |
| website/grid_logo_website.png | Adds a PNG logo asset (currently appears unused by config/content). |
| website/data/table_angular_spherical.csv | Adds CSV data rendered into the new “Conventions” page tables. |
| website/data/table_angular_lebedev.csv | Adds CSV data rendered into the new “Conventions” page tables. |
| website/conventions.ipynb | New conventions page for spherical coords/harmonics and angular grids tables. |
| website/_toc.yml | Defines Jupyter Book table of contents for user docs, tutorials, and API docs. |
| website/_config.yml | Configures Jupyter Book (Sphinx extensions, parsing, repo links, logo, launch buttons). |
| website/README.md | New instructions for building/publishing the Jupyter Book site. |
| src/grid/ngrid.py | Docstring formatting tweak in MultiDomainGrid.weights docs. |
| src/grid/basegrid.py | Updates Grid.integrate() docstring wording/types. |
| examples/One_dimensional_grids.ipynb | Minor markdown structure tweak (adds section heading). |
| examples/Interpolation_and_Poisson.ipynb | Converts LaTeX blocks to MyST {math} fences; clears execution counts. |
| doc/table_rtransform.csv | Removes old generated table CSV used by the Sphinx/RST docs. |
| doc/table_onedgrids.csv | Removes old generated table CSV used by the Sphinx/RST docs. |
| doc/table_modules.csv | Removes old module table CSV used by the Sphinx/RST docs. |
| doc/radial_transf.rst | Removes old RST page superseded by website/radial_transf.ipynb. |
| doc/onedgrids.rst | Removes old RST page superseded by website/onedgrids.ipynb. |
| doc/notebooks/quickstart.nblink | Removes old nbsphinx-link pointer file (book stages examples directly). |
| doc/notebooks/one_dimensional_grids.nblink | Removes old nbsphinx-link pointer file. |
| doc/notebooks/multipole_moments.nblink | Removes old nbsphinx-link pointer file. |
| doc/notebooks/molecular_grid_construction.nblink | Removes old nbsphinx-link pointer file. |
| doc/notebooks/molecular_grid.nblink | Removes old nbsphinx-link pointer file. |
| doc/notebooks/interpolation_poisson.nblink | Removes old nbsphinx-link pointer file. |
| doc/notebooks/cubic_grid.nblink | Removes old nbsphinx-link pointer file. |
| doc/notebooks/atom_grid_construction.nblink | Removes old nbsphinx-link pointer file. |
| doc/notebooks/atom_grid.nblink | Removes old nbsphinx-link pointer file. |
| doc/notebooks/angular_grid.nblink | Removes old nbsphinx-link pointer file. |
| doc/installation.rst | Removes old RST installation page superseded by website/installation.ipynb. |
| doc/index.rst | Removes old Sphinx site entrypoint superseded by website/intro.md. |
| doc/gen_table_rtransform.py | Removes legacy script that generated RST-era tables. |
| doc/gen_table_onedgrids.py | Removes legacy script that generated RST-era tables. |
| doc/gen_api.sh | Removes old API generation helper script (now done in CI via sphinx apidoc). |
| doc/conventions.rst | Removes old RST conventions page superseded by website/conventions.ipynb. |
| doc/conf.py | Removes old Sphinx configuration for the RST site (replaced by Jupyter Book config). |
| doc/_static/css/override.css | Removes old RTD-theme-specific CSS for the RST site. |
| doc/README.md | Removes old doc build instructions (replaced by website/README.md). |
| .github/workflows/website.yaml | Updates CI/CD to build and deploy the Jupyter Book site + generate API docs + stage examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This PR migrates the grid's website to Jupyter Books.
This is an incremental update (I plan to migrate to the new Jupyter Books version based on myst).