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

Use readthedocs CI for building documentation #3328

Merged
merged 12 commits into from
Feb 11, 2025
Merged

Conversation

JCGoran
Copy link
Collaborator

@JCGoran JCGoran commented Feb 10, 2025

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:

  • we don't have 2 CIs that do the same thing
  • we actually get automatic feedback when the documentation fails to build and deploy; currently we need to go through the tedious process of enabling each build by hand on RTD to see whether it works properly

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.

@JCGoran JCGoran marked this pull request as ready for review February 10, 2025 10:38
@JCGoran
Copy link
Collaborator Author

JCGoran commented Feb 10, 2025

You can see the docs for this PR on https://nrn--3328.org.readthedocs.build/en/3328/ (pattern appears to be https://nrn--[PR_NUMBER].org.readthedocs.build/en/[PR_NUMBER]/; you can also click on "Details" next to the docs/readthedocs.org:nrn CI job).

@pramodk @nrnhines to merge this, we would need to disable the requirement for the Documentation CI since I don't have permissions to do this, and enable it for docs/readthedocs.org:nrn (or whatever it's called in the settings).

@nrnhines
Copy link
Member

nrnhines commented Feb 10, 2025

@pramodk @nrnhines to merge this, we would need to disable the requirement for the Documentation CI since I don't have permissions to do this, and enable it for docs/readthedocs.org:nrn (or whatever it's called in the settings).

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
image

Copy link

codecov bot commented Feb 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.08%. Comparing base (df306bd) to head (a1a1951).
Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

Copy link

✔️ a1a1951 -> Azure artifacts URL

@JCGoran JCGoran merged commit ca6e145 into master Feb 11, 2025
38 checks passed
@JCGoran JCGoran deleted the jelic/ci_use_rtd branch February 11, 2025 08:48
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