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.

Sign up for GitHub

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

Jump to bottom

make GitHub action for testing compiling API documentation #2

Open
dave-doty opened this issue Apr 18, 2021 · 0 comments
Open

make GitHub action for testing compiling API documentation #2

dave-doty opened this issue Apr 18, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@dave-doty
Copy link
Member

dave-doty commented Apr 18, 2021 •
edited
Loading

It would be good to test out locally first with Sphinx to make sure there's no doc compilation errors.

See here for example:

https://github.com/UC-Davis-molecular-computing/scadnano-python-package/blob/master/.github/workflows/docs-check.yml

This action should just check for errors. The actual posting of API docs to readthedocs is done by readthedocs itself, not by GitHub.
@dave-doty dave-doty added the enhancement New feature or request label Apr 18, 2021
@dave-doty dave-doty changed the title make GitHub action for compiling API documentation and posting to readthedocs make GitHub action for testing compiling API documentation May 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dave-doty