Documentation generation via Github Actions - #127
Merged
Conversation
added 8 commits
April 1, 2026 13:25
…or when a PR is merged into master
keflavich
reviewed
Apr 1, 2026
keflavich
left a comment
keflavich
left a comment
Collaborator
There was a problem hiding this comment.
I have a few suggestions for cleanup, but overall looks fine.
Comment on lines
+12
to
+13
| - Make sure to close the figures after they are saved using ``plt.close()``; | ||
| this script is not meant to display anything. |
Collaborator
There was a problem hiding this comment.
let's use the 'agg' backend, then
Co-authored-by: Adam Ginsburg <keflavich@gmail.com>
Collaborator
Author
|
Great, thanks for checking! I'll merge this and then update the Pages settings to point to the new branch. |
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
2 participants
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 includes a Github Action that will generate the documentation automatically to be hosted on Github Pages. It uses Sphinx to build the documentation, and then peaceiris' action for deploying the site from the
gh-pagesbranch.I've also converted the
documentation_figures.ipynbfile into a proper script,documentation_figures.py, so the figures can be generated during the Action.I've set the action to run only on changes to the
masterbranch, either through a direct push or when a PR is merged into it. The latter case might be redundant there, but I'm not sure, and it can't hurt to have it (hopefully). I'm not an expert on this stuff, so if anyone sees any issues please let me know! That being said, this does mean that this won't run until we merge this PR, so we can't exactly test it... but I've tested it on my fork of the repo and it seems fine.