search

payu-org / payu

A workflow management tool for numerical models on the NCI computing systems
Apache License 2.0
18 stars 25 forks source link

Fix readthedocs configuration #408

Closed aidanheerdegen closed 5 months ago

aidanheerdegen commented 5 months ago

Add readthedocs configuration file as this is now a requirement.

Configured RTD to run on PRs, so should get a status if this fix worked.

Fixes #406

aidanheerdegen commented 5 months ago

Well that seemed to have worked. The preview docs have been generated. Can you check the preview @jo-basevi to make sure it has your most recent updates?

aidanheerdegen commented 5 months ago

According to the RTD logs, the docs build took 29s, and it is being done on RTD hardware, so I don't think it is a problem to have this turned on routinely for PRs. It would have led to us noticing the builds were failing a lot sooner. Apparently this requirement was turned on in September.

jo-basevi commented 5 months ago

Well that seemed to have worked. The preview docs have been generated. Can you check the preview @jo-basevi to make sure it has your most recent updates?

The previews have the most recent updates!

From what I can tell, the currently the docs show only the latest and stable version, is it possible to get previous versions e.g. 1.0.30?

aidanheerdegen commented 5 months ago

is it possible to get previous versions

It looks like it is possible, but would involve using branches and adding the config file to them

https://stackoverflow.com/questions/72324316/build-documentation-for-older-version-before-readthedocs-yaml-was-added-to-repo#comment128600046_72324316

We made a 1.0 branch so we could back-port bug fixes etc, so it would be relatively straightforward

https://github.com/payu-org/payu/tree/release/1.0

But we'd probably use a new tag to get the "old" version of the docs.