Skip to content

ci(doc): add doc build caching #2342

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

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

Conversation

PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Jun 5, 2025

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 from last run on this branch
  • the cache from master

The cache should only contain files where Sphinx can detect changes:

  • this is true for modules used by AutoAPI
  • this is true for example scripts

The cache could be based on the hash of a lock file, as differences in installed graphics dependencies 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.

@PProfizi PProfizi self-assigned this Jun 5, 2025
@PProfizi PProfizi added the CI/CD Related to CI/CD label Jun 5, 2025
Copy link

codecov bot commented Jun 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.10%. Comparing base (3f5994b) to head (a749326).
Report is 9 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2342   +/-   ##
=======================================
  Coverage   84.09%   84.10%           
=======================================
  Files          91       91           
  Lines       10522    10529    +7     
=======================================
+ Hits         8849     8855    +6     
- Misses       1673     1674    +1     

@PProfizi PProfizi requested review from moe-ad and removed request for moe-ad June 6, 2025 07:55
Copy link
Contributor

github-actions bot commented Jun 6, 2025

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.

Copy link
Contributor

Some tests with 'continue-on-error: true' have failed:

  • PyDPF-Post docstring tests on windows-latest

Created by continue-on-error-comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Related to CI/CD
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant