Add experimental RTD doc support #105
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds RTD doc builds with PR-Preview support. This is still an experiment to see how we want to continue on this. Notes: - The build in .readthedocs.yaml is horrific and has to be done because I inist on running the same doc generation locally as in the ci. - .readthedocs.yaml is very limited in what it allows. Dependencies need to be installable via pip. No system packages can be installed - My initial attempt to build doc in one of our GH Actions and simply unpack the tarball would work in principle but is complicated to setup so that it offers feature parity to the default RTD/GH integration. When using a prebuild doc tarball you need to wait for the tarball to be created. This means you can no longer use the installed webhook as this will get triggeren on push. You then need to use the RTD rest API to trigger the build once the doc build is finished. This then in turn means you need to call the GH rest api from the RTD build to signal start / success / failure of the build back to GH.
Ozaq
force-pushed
the
feature/add-doc-preview
branch
from
a3af3ba to
1eddc71
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #105 +/- ##
========================================
Coverage 63.84% 63.84%
========================================
Files 281 281
Lines 15815 15815
Branches 1643 1643
========================================
Hits 10097 10097
Misses 5718 5718 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds RTD doc builds with PR-Preview support. This is still an experiment to see how we want to continue on this.
Notes: