Open
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
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.
Resolves #354 |
Adds
sphinx-galleryto the documentation build, which allows us to write examples in.pyformat using syntax similar to notebooks, but in plaintext files.These scripts are then run when the documentation is built, and inserted into a gallery view (html) along with links to downloadable notebook versions of these scripts. Notebooks do not re-run if they are unchanged between builds, however some of the examples (notably
spherical_harmonic_transform.py) are quite slow and somewhat resource intensive due to the data they need to load and plot.TDLR;
nbsphinxornbsphinx-link. These have been dropped forsphinx-gallery.notebooks/directory and its contents can be removed and replaced with equivalent scripts inexmaples/.JAX_CUDA_HEALPix.ipynbhas been left alone since this notebook needs to run on a CUDA-enabled machine, which the docs build currently doesn't do. The gallery index page has a placeholder hard-link to this notebook inserted so it is still visible in the docs build.notebooks/plotting_functions.pyalso still remains, despite not being used anywhere in the package or notebook code. This file could be removed though.notebooks/datahas moved toexamples/data.docs/tutorialshas been removed, since we no longer need tonblinkeverything..gitignore, since the build will now auto-populate it when run.cartopyis required for the docs build since one of the examples depends on it, and this dependency was not listed previously in thepyproject.toml. Similarly,torchis also needed.docsdependency, a new optional dependency as been made (examples) to save on bloat. It also means that anyone with thedocsdependency should be able to build the documentation so long as they tellsphinx-gallerynot to run the scripts and just render them. Installingdocs,exmapleswill enable a full documentation build complete with the notebook rendering bysphinx-gallery.README.mdand some other user-facing pages to be consistent with the new location and format of the examples.