Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add workflow to publish docs on Github Pages #4

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

pconrad
Copy link

@pconrad pconrad commented Oct 21, 2023

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.

image

You can then automatically get a link by clicking the gear icon, upper right

image

And then clicking the checkbox for github pages:

image

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.

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
@pconrad pconrad marked this pull request as draft October 21, 2023 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant