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

Docs: replace CircleCI build with ReadTheDocs #5279

Merged
merged 2 commits into from
Dec 17, 2021

Conversation

sphuber
Copy link
Contributor

@sphuber sphuber commented Dec 17, 2021

Fixes #4104

The documentation was being built on CircleCI instead of GHA like the
rest of the CI pipeline, because the former would allow the built
HTML documentation to be inspected as an artifact, whereas for the
latter this wasn't possible.

It is now possible to do the same with ReadTheDocs, and since we already
use that to host the documentation, that means we can now drop CircleCI.

@chrisjsewell
Copy link
Member

I've just turned on the RTD PR builds then.
As mentioned (#4104 (comment)), my only slight concern was on build limits

@sphuber
Copy link
Contributor Author

sphuber commented Dec 17, 2021

I've just turned on the RTD PR builds then.

Also did that already, but build doesn't seem to get triggered here. Do we need to configure a webhook here in this repo explicitly?

EDIT: never mind, I did this on the old aiida meta package 😅 Wondering if we should just remove it, since we stopped supporting and releasing the meta package after v1.0

@chrisjsewell
Copy link
Member

Perhaps you didn't save it, because it was selected when I went to the settings.
Try re-triggering the CI again

@chrisjsewell
Copy link
Member

I did this on the old aiida meta package

Don't even know what this is lol

@sphuber sphuber force-pushed the fix/4104/replace-circle-ci branch from c9504e6 to 562e15a Compare December 17, 2021 12:37
@sphuber
Copy link
Contributor Author

sphuber commented Dec 17, 2021

Don't even know what this is lol

It is this package. Those are the docs for the aiida PyPI package. This was a wrapper package we used to maintain that would install aiida-core and some of the main plugins; aiida-quantumespresso, aiida-codtools and aiida-nwchem I believe.

@sphuber
Copy link
Contributor Author

sphuber commented Dec 17, 2021

Retriggered the CI but I don't see it triggering the RTD build

@chrisjsewell
Copy link
Member

ok give it another go

The documentation was being built on CircleCI instead of GHA like the
rest of the CI pipeline, because the former would allow the built
HTML documentation to be inspected as an artifact, whereas for the
latter this wasn't possible.

It is now possible to do the same with ReadTheDocs, and since we already
use that to host the documentation, that means we can now drop CircleCI.
@sphuber sphuber force-pushed the fix/4104/replace-circle-ci branch from 562e15a to f76d3be Compare December 17, 2021 12:42
@chrisjsewell
Copy link
Member

there you go 👍

@sphuber
Copy link
Contributor Author

sphuber commented Dec 17, 2021

there you go +1

What did you change?

@chrisjsewell
Copy link
Member

magic! (add PR events to the webhook)

@sphuber sphuber merged commit 7fad822 into aiidateam:develop Dec 17, 2021
@sphuber sphuber deleted the fix/4104/replace-circle-ci branch December 17, 2021 13:42
sphuber added a commit that referenced this pull request Mar 7, 2022
The documentation was being built on CircleCI instead of GHA like the
rest of the CI pipeline, because the former would allow the built
HTML documentation to be inspected as an artifact, whereas for the
latter this wasn't possible.

It is now possible to do the same with ReadTheDocs, and since we already
use that to host the documentation, that means we can now drop CircleCI.

Cherry-pick: 7fad822
sphuber added a commit that referenced this pull request Mar 7, 2022
The documentation was being built on CircleCI instead of GHA like the
rest of the CI pipeline, because the former would allow the built
HTML documentation to be inspected as an artifact, whereas for the
latter this wasn't possible.

It is now possible to do the same with ReadTheDocs, and since we already
use that to host the documentation, that means we can now drop CircleCI.

Cherry-pick: 7fad822
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.

Move doc builds back to GitHub Actions (when artefacts supported)
2 participants