search

nexusformat / definitions

Definitions of the NeXus Standard File Structure and Contents
https://manual.nexusformat.org/
Other
26 stars 55 forks source link

HTML artifacts for reviewers #1280

Open woutdenolf opened 1 year ago

woutdenolf commented 1 year ago

When reviewing PRs you often want to see the rendered documentation. Currently you need to pull the branch and build locally. It would be much more convenient if you could see the documentation build by the CI.

woutdenolf commented 1 year ago

Possible solutions:

  1. github workflow artifacts: https://github.com/nexusformat/definitions/pull/1041 (you still need to download the docs and view them locally)
  2. readthedocs.org: https://docs.readthedocs.io/en/stable/pull-requests.html (you will be able to see the docs without the need for downloading but they may be indexed by search engines, a robots.txt may be able to prevent this)
  3. github pages: https://github.com/marketplace/actions/deploy-pr-preview (same as readthedocs)