martius-lab / cluster_utils

https://cluster-utils.readthedocs.io/stable/
Other
12 stars 0 forks source link

chore: Build documentation and deploy to GitHub Pages #76

Closed luator closed 7 months ago

luator commented 7 months ago

Rebuild is done for push to master, pull requests that have a change inside docs/ and workflow_dispatch. Publishing to Pages only happens for push on master or workflow_dispatch if the corresponding option is set.

luator commented 7 months ago

Unfortunately this is a bit annoying to properly test as deployment is only happening when pushing to master. Se we cannot see how the build documentation looks like before merging.

mseitzer commented 7 months ago

Can the built documentation be used as an ouput artifact of the job? Then it would be possible to manually download and inspect.

luator commented 7 months ago

Can the built documentation be used as an ouput artifact of the job? Then it would be possible to manually download and inspect.

I think in theory yes, but it seems it only creates an artifact when actually publishing.