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

[Feature] Add ReadTheDocs to CI #1845

Closed
bmhan12 opened this issue Mar 24, 2022 · 4 comments
Closed

[Feature] Add ReadTheDocs to CI #1845

bmhan12 opened this issue Mar 24, 2022 · 4 comments
Assignees
Labels
type: documentation type: testing Unit tests, non-regression testing, ...

Comments

@bmhan12
Copy link
Contributor

bmhan12 commented Mar 24, 2022

Make ReadTheDocs build as part of our CI checks.

ReadTheDocs does have a feature so you can trigger RTD builds on pull requests:
https://docs.readthedocs.io/en/stable/pull-requests.html

It's a toggle on/off with the option to make PR builds private or public to everyone.
I think we want public, so the PR author can view the build.

@rrsettgast, I have admin access, should I flip it on?

@bmhan12 bmhan12 added type: testing Unit tests, non-regression testing, ... type: documentation labels Mar 24, 2022
@bmhan12 bmhan12 self-assigned this Mar 24, 2022
@rrsettgast
Copy link
Member

Yes!!!

@bmhan12
Copy link
Contributor Author

bmhan12 commented Mar 24, 2022

RTD builds should be on for PR's now.

RTD on

@TotoGaz
Copy link
Contributor

TotoGaz commented Mar 24, 2022

Will it deploy for all PRs as well? This may not be what we want?

@klevzoff
Copy link
Contributor

@rrsettgast @bmhan12 I got a failed check in #1847, but when I click it I get a 404 page from readthedocs. It would be nice to have the ability to see the error log and re-trigger the build, but I imagine it's impossible without giving everyone RTD admin access?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation type: testing Unit tests, non-regression testing, ...
Projects
None yet
Development

No branches or pull requests

4 participants