Add make tutorial to docs CI workflow #3012
Conversation
|
Not sure what's going on, but the tutorial HTML build is taking forever on the GitHub CI machines. I might have to move this to a separate stage to avoid a big increase in CI turnaround time. |
that's probably the reason we didn't add this to ci |
|
Still, even on my slow personal laptop |
| pip freeze | ||
| - name: Build HTML from tutorials | ||
| run: | | ||
| SPHINXOPTS="-E" make tutorial |
There was a problem hiding this comment.
I disabled the -W Sphinx flag that treats warnings as errors in the CI builds of the tutorial web pages because there are a number of unfixed warnings in dev and they appear unstable across sphinx versions.
| @@ -62,6 +62,40 @@ jobs: | |||
| run: | | |||
| make docs | |||
| make doctest | |||
| tutorials-html: | |||
There was a problem hiding this comment.
I moved the tutorial build to a separate stage to limit the impact on CI time
|
@fritzo can you take a look at this again? I was helping someone today with issues building the example HTML and this seemed like it would be a useful check to rule out bugs in the tutorials as a cause of build issues versus incorrect versions of Sphinx and related dependencies.
This seems to be resolved by not using multiple Sphinx workers (i.e. removing the |
Motivated by off-target Sphinx build errors in #3006. Can't remember if there was a reason we weren't doing this, feel free to close if there was one...