Add workflow to publish docs on Github Pages #4
Conversation
This file contains 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
Also changes theme to 'classic'; the previous theme is no longer included in standard Sphinx and requires a separate `pip install ...` To simplify the workflow, chose a built-in theme.
pc - add github workflow to publish sphinx docs
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.
NOTE: Converting to draft because, for reasons that are still not clear, the published docs are missing the api docs.
I'm working on debugging that issue.
In case the current home of the documentation (on UCSB's server) were to ever disappear, in this PR, we add a Github Workflow that publishes the Sphinx documentation to the gh-pages branch of the repo.
If you then set Github Pages with these settings, the documentation is automatically published to the github pages site for the repo.
You can then automatically get a link by clicking the gear icon, upper right
And then clicking the checkbox for github pages:
If you choose to merge this PR, you may then want to change the link in the README.md to point to the docs on Github Pages.