Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Viewing rendered docs from a PR to check #363

Open
paddyroddy opened this issue Apr 25, 2024 · 2 comments
Open

Viewing rendered docs from a PR to check #363

paddyroddy opened this issue Apr 25, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@paddyroddy
Copy link
Member

paddyroddy commented Apr 25, 2024 •
edited by giordano
Loading

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 #358 (comment)
@paddyroddy paddyroddy added the enhancement New feature or request label Apr 25, 2024
@giordano giordano mentioned this issue Apr 25, 2024
Merged
@dstansby
Copy link
Member

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

@dstansby
Copy link
Member

dstansby commented May 9, 2024

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.

This was referenced Jun 1, 2024
Merged
Merged
dstansby pushed a commit that referenced this issue Jun 1, 2024
@samcunliffe
Revert "Lock file maintenance (#376)" (#377)
0763917 
This reverts commit PR #376 (commit
2e196ec) which broke [the pages
action](https://github.com/UCL-ARC/python-tooling/actions/runs/9329000737/job/25680916032).

Side note, we should probably rerun the pages action (but without
deployment) as a CI check if anything in the docs folder is changed. (A
step along the way to #363.)
samcunliffe added a commit that referenced this issue Jun 4, 2024
@samcunliffe
Run pages build on PRs that touch docs. (#378)
b918e01 
Should help notice bugs like #376 → #377.

Follows from
- #377 

Along the way to solving
- #363
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dstansby @paddyroddy