-
Notifications
You must be signed in to change notification settings - Fork 122
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
Use readthedocs CI for building documentation #3328
Conversation
You can see the docs for this PR on https://nrn--3328.org.readthedocs.build/en/3328/ (pattern appears to be @pramodk @nrnhines to merge this, we would need to disable the requirement for the |
|
I'm happy to do that. Just want to ask if the only (slightly) negative consequence is that for a release, it is necessary to manually verify that the readthedocs successfully concluded. (Or does the github ci still show a failure but it does not prevent merging?) Nevermind. There appears to be no negative consequence. You noted "we actually get automatic feedback when the documentation fails to build and deploy" and I see in the CI list |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3328 +/- ##
=======================================
Coverage 67.08% 67.08%
=======================================
Files 571 571
Lines 111039 111039
=======================================
Hits 74485 74485
Misses 36554 36554 ☔ View full report in Codecov by Sentry. |
✔️ a1a1951 -> Azure artifacts URL |
RTD supports PR builds: https://docs.readthedocs.com/platform/stable/guides/pull-requests.html
so we may as well use it instead of the github action for the docs.
This brings two advantages:
Note that this is based on #3327 because strictly speaking the two PRs are logically separate, but if needed one can just merge this one.