ci(doc): add doc build examples caching #2342
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #2342 +/- ##
=======================================
Coverage 84.20% 84.20%
=======================================
Files 91 91
Lines 10686 10686
=======================================
Hits 8998 8998
Misses 1688 1688 |
|
The documentation for this pull request will be available at https://dpf.docs.pyansys.com/pull/2342. Please allow some time for the documentation to be deployed. |
…] extension" This reverts commit 544630e.
|
@Revathyvenugopal162 pinging you FYI, this PR tries to use a few sphinx tricks to improve config change detection. |
|
We can see here that examples did not run the second time. The cache generated is 170Mb The second run of doc generation job took 20min instead of 45. |
|
Some tests with 'continue-on-error: true' have failed:
|
The goal is to accelerate doc building using cached Sphinx build files whenever possible.
The caching logic is to retrieve, by order of priority:
The cache should only contain files where Sphinx can detect changes:
The cache could be based on the hash of a lock file, as differences in installed
graphicsdependencies could result in changes despite Sphinx not detecting changes in the actual scripts.That means however the cache will only work if no changes in dependencies.