Build docs in PR and clean workflows #296
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
junpenglao
previously approved these changes
Sep 19, 2022
|
Waiting for the build to complete to see if we can catch errors. |
rlouf
force-pushed
the
build-docs-in-prs
branch
from
2a09f09 to
8989da9
Compare
Codecov Report
@@ Coverage Diff @@
## main #296 +/- ##
=======================================
Coverage 98.69% 98.69%
=======================================
Files 46 46
Lines 1917 1917
=======================================
Hits 1892 1892
Misses 25 25 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
rlouf
force-pushed
the
build-docs-in-prs
branch
2 times, most recently
from
3cfd6c5 to
dad27a3
Compare
Merged
|
Waiting for #277 to be merged to rebase and check that CI passes. |
|
BTW, now that we are building docs on each PR, could we parse the run time and use it as additional benchmark/regression test? |
|
That's a good idea although I'd rather we focus our efforts on #163. |
The documentation is currently only built when we merge on `main`, which means that we need to trust that contributors (including ourselves) are running the examples locally before pushing. This is too much to ask (and cumbersome), so in this PR we edit the workflows so that docs are built for each PR. They are only deployed when merging on `main`.
rlouf
force-pushed
the
build-docs-in-prs
branch
from
dad27a3 to
2cb9eae
Compare
junpenglao
pushed a commit
that referenced
this pull request
Mar 12, 2024
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.
In this PR I allow the CI to build docs on PRs, and do some light cleaning of the workflow files. Closes #294