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.

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

Fix readthedocs configuration #408

Merged
merged 2 commits into from
Jan 23, 2024
Merged

Conversation

aidanheerdegen
Copy link
Collaborator

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 aidanheerdegen self-assigned this Jan 23, 2024
@aidanheerdegen
Copy link
Collaborator Author

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
Copy link
Collaborator Author

aidanheerdegen commented Jan 23, 2024

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
Copy link
Collaborator

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?

Copy link
Collaborator

@jo-basevi jo-basevi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@aidanheerdegen
Copy link
Collaborator Author

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.

@aidanheerdegen aidanheerdegen merged commit d7fdc5a into master Jan 23, 2024
7 checks passed
@aidanheerdegen aidanheerdegen deleted the aidanheerdegen/issue406 branch January 23, 2024 05:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

readthedocs deployment broken
2 participants