Compile docs in GitHub Actions CI #1620
Merged
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
This is to make sure that there are no doc build failures introduced by PRs. In future I want to expand this check to be more strict. Since it comes up separately in CI it can be ignored on reviwer discrescion but at least it will make problems visible. Also: - Fix some things in docs that were causing warnings. There are still many warnings related to references but I will fix them later. - Added a `docs` evnrionment for tox which builds the docs, this is also what is used from CI.
aucampia
force-pushed
the
iwana-20211227T2339-check_sphinx
branch
from
c5b3d8e
to
b0d17a0
Compare
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.
This is to make sure that there are no doc build failures introduced by
PRs.
In future I want to expand this check to be more strict. Since it comes up
separately in CI it can be ignored on reviwer discrescion but at least
it will make problems visible.
Also:
many warnings related to references but I will fix them later.
docsevnrionment for tox which builds the docs, this is alsowhat is used from CI.
Fixes #1521