search

UCL-ARC / python-tooling

Python package template for new research software projects
http://github-pages.arc.ucl.ac.uk/python-tooling/
MIT License
43 stars 2 forks source link

Viewing rendered docs from a PR to check #363

Open paddyroddy opened 6 months ago

paddyroddy commented 6 months ago

We don't have any way of viewing rendered docs from a PR to check them before merging do we?

For what is worth, we do that in the excalibur benchmarking repository: https://github.com/ukri-excalibur/excalibur-tests/blob/ede38fa104eed72557233cbfc76b230727973791/.github/workflows/docs.yml (this is using mkdocs rather than jekyll, but to give an idea of what one can do to accomplish that).

Originally posted by @giordano in https://github.com/UCL-ARC/python-tooling/issues/358#issuecomment-2077433013

dstansby commented 6 months ago

https://readthedocs.org has pretty good support for pull request previews: https://docs.readthedocs.io/en/stable/pull-requests.html

dstansby commented 6 months ago

Or https://github.com/marketplace/actions/deploy-pr-preview might be useful, since I don't think readthedocs can (easily) build jekyll sites like this one.