Skip to content

Bare documentation infrastructure#131

Open
ccarouge wants to merge 4 commits into
mainfrom
add-documentation-infra
Open

Bare documentation infrastructure#131
ccarouge wants to merge 4 commits into
mainfrom
add-documentation-infra

Conversation

@ccarouge
Copy link
Copy Markdown
Member

Adds the bare infrastructure for the documentation based off the configs doc infrastructure.

This builds locally. @atteggiani Should we look at using GitHub pages or readthedocs for this one? The decision to go with one or the other hasn't been made but we may have some idea of where it is likely to get. We probably don't need to setup both now, just choose one. Information for RTD is in this PR.

@atteggiani
Copy link
Copy Markdown
Collaborator

atteggiani commented May 15, 2026

I agree we shouldn't go with both.
As such, my preference would go to use RTD.
Some templates for additional files are in Documentation infra

@ccarouge
Copy link
Copy Markdown
Member Author

We've got a build from the PR! (see the "More Details" from the action). https://cmip7-input--131.org.readthedocs.build/en/131/
I've added tech.accessnri as a maintainer on readthedocs so others can connect and manage stuff.

I think we are good to merge.

@ccarouge ccarouge requested review from atteggiani and penguian May 15, 2026 04:47
@ccarouge
Copy link
Copy Markdown
Member Author

@atteggiani I've used the GitHub OAuth app for RTD because I'm not setup with the new GitHub App. So might need to migrate, soz.

@ccarouge
Copy link
Copy Markdown
Member Author

@penguian not sure what to do about the failure of the pre-commit-check.

@atteggiani
Copy link
Copy Markdown
Collaborator

@atteggiani I've used the GitHub OAuth app for RTD because I'm not setup with the new GitHub App. So might need to migrate, soz.

No problem.
Actually the GitHub App has never been connected to ACCESS-NRI, so we've all always used RTD OAuth app (also from access-bot RTD account).
We might think about migrating after we finalise the RTD shenanigans.

Did you use your RTD account or access-bot to set this up?

@ccarouge
Copy link
Copy Markdown
Member Author

@atteggiani:

Did you use your RTD account or access-bot to set this up?

Mine, but access-bot is a full maintainer. Actually, I forgot to give repository permissions to access-bot. So it is a maintainer, but it might not have the perms it needs to be fully functional.

@atteggiani
Copy link
Copy Markdown
Collaborator

Sounds good, thank you!

Actually, I forgot to give repository permissions to access-bot. So it is a maintainer, but it might not have the perms it needs to be fully functional.

Once the RTD project is setup, GitHub repo admin permissions are not needed to still be able to manage the RTD project.
I would not give access-bot admin permissions on the GitHub repo.

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.

2 participants