search

LLNL / scr

SCR caches checkpoint data in storage on the compute nodes of a Linux cluster to provide a fast, scalable checkpoint / restart capability for MPI codes.
http://computing.llnl.gov/projects/scalable-checkpoint-restart-for-mpi
Other
99 stars 36 forks source link

Docs: update to latest doc deps #587

Closed CamStan closed 9 months ago

CamStan commented 9 months ago

Update the jinja2 version due to the Dependabot alert.

Updating the rest of the doc deps to their latest versions.

mcfadden8 commented 9 months ago

Thanks @CamStan - Do we have a way of testing this prior to merging? Is there a link that we can go to that will show what the documents will look like with these updates?

CamStan commented 9 months ago

Do we have a way of testing this prior to merging? Is there a link that we can go to that will show what the documents will look like with these updates?

I usually do test it before bigger changes, but didn't this time. I'll do it real quick and provide the link

CamStan commented 9 months ago

@mcfadden8, I pushed the updated requirements.txt file to my test-docs repo here, where both sets of docs get built using the same requirements file.

SCR docs test build: https://readthedocs.org/projects/camstan-test-docs-scr/builds/23173907/ SCR Developer docs test build: https://readthedocs.org/projects/camstan-test-docs-scrdev/builds/23173905/

Here is them both rendered: SCR docs: https://camstan-test-docs-scr.readthedocs.io/en/latest/ SCR Developer docs: https://camstan-test-docs-scrdev.readthedocs.io/en/latest/

CamStan commented 9 months ago

There is a way to tell ReadTheDocs to build doc changes from pull requests and have it as a required check before merging. I played with this a couple months ago with UnifyFS, but have yet to get it to work properly. It's a new feature, so might be getting things ironed out still.