Add documentation build workflow #551
Conversation
.github/workflows/test-doc-build.yml
Outdated
| - run: python -m pip install . | ||
| - run: | | ||
| python -m sphinx.ext.apidoc --separate --no-toc -o docs/source/api -t docs/source/api/templates envisage */tests | ||
| python -m sphinx -b html docs/source docs/build |
There was a problem hiding this comment.
Can we bundle the html into an artefact so it can be manually checked for correctness if needed?
There was a problem hiding this comment.
Yep, that's a good idea. May require some experimentation. I'll see what I can do.
There was a problem hiding this comment.
Done in 31b2c8c
I've tweaked the Sphinx build command to move the doctrees (which we don't need) out of the build directory, and make the build directory build/html rather than plain old build.
Let's see if the built artifact is useful.
Potentially, this could be the first step in an automated build-docs-at-release-time workflow.
There was a problem hiding this comment.
Build artifact seems to be working. I'd be a bit happier if the .zip file gave something with an html top-level directory. I've just pushed a change that might just make that happen.
This PR adds a documentation build test workflow - the intent is to catch PRs that cause the documentation to be unbuildable for some reason.
Partly motivated by the fact that #513 broke the documentation build and we didn't notice, but it's good to have this anyway.
Closes #552