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 sphinx doc builds to master, push to Github Pages for this repo #170

Open
dotsdl opened this issue Feb 1, 2022 · 0 comments
Open

Add sphinx doc builds to master, push to Github Pages for this repo #170

dotsdl opened this issue Feb 1, 2022 · 0 comments
Milestone

Comments

@dotsdl
Copy link
Member

dotsdl commented Feb 1, 2022

We want to start building out docs for the components exposed by fah-xchem as we develop them further. In the past we would use ReadTheDocs for this, but conda installs there are slow and prone to timeouts (or memory exhaustion), so we may be better served by sticking with Github Actions for this.

We could write an Action that builds the docs and pushes them to the gh-pages branch of the repo. This would work fine for docs built from e.g. master, but may not work well if we want to support display of docs for many different releases. We can proceed with docs built only for master for now.

@dotsdl dotsdl added this to the v0.2.0 milestone Feb 25, 2022
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

No branches or pull requests

1 participant