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

Add sphinx building to GitHub Actions #1508

Closed
djhoese opened this issue Jan 14, 2021 · 2 comments
Closed

Add sphinx building to GitHub Actions #1508

djhoese opened this issue Jan 14, 2021 · 2 comments
Labels
cleanup Code cleanup but otherwise no change in functionality documentation

Comments

@djhoese
Copy link
Member

djhoese commented Jan 14, 2021

I've noticed this a couple times when working on sphinx documentation. After a couple PRs suddenly there are a ton of warnings when generating the sphinx documentation. 99% of the time these aren't supposed to be there and should get fixed during the PR stage. I think adding it as a step in the unit test GitHub action/workflow would be a good idea, it could even be made as an allowed failure (or whatever the equivalent is in GH Action land).
@djhoese djhoese added documentation cleanup Code cleanup but otherwise no change in functionality labels Jan 14, 2021
@djhoese
Copy link
Member Author

djhoese commented Jan 14, 2021

Oh I should have mentioned that there is a flag you can provide to sphinx-build to error on any warnings.

@djhoese
Copy link
Member Author

djhoese commented Mar 2, 2021

Done in #1543

@djhoese djhoese closed this as completed Mar 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cleanup Code cleanup but otherwise no change in functionality documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@djhoese