Skip to content

Remove stale Sphinx doctrees cache from Python docs CI job - #89

Merged
MLopez-Ibanez merged 5 commits into
mainfrom
copilot/fix-failing-build-documentation-job
Oct 26, 2026
Merged

MLopez-Ibanez merged 5 commits into
mainfrom
copilot/fix-failing-build-documentation-job

Conversation

Copilot AI commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

The "Build documentation (3.12, ubuntu-latest)" job failed on the crossover-operators PR because Sphinx runs with warnings as errors. The log showed 52 warnings, in two groups:

  • Duplicate labels such as bench-ndom, with the "other instance" reported in index.rst, even though index.rst no longer includes benchmarks.inc.rst on that commit.
  • Missing autosummary stubs and unresolved references for all nine *_crossover functions, even though they are exported from moocore/__init__.py and _crossover.py was built into the installed package.

The build-doc job restores python/doc/_build/doctrees/ from actions/cache. The cache key hashes only conf.py, and restore-keys: intersphinx- lets any older cache match. The restored Sphinx environment can therefore predate the current sources, which fits both groups of warnings.

  • .github/workflows/python.yml: removed the "Cache intersphinx inventories" step, so the docs build always starts from a clean doctree. The cost is that intersphinx inventories are re-fetched on every run.

I couldn't run the docs build. This branch is based on main, and the failing PR branch wasn't available. Stale cache state is the explanation that fits the log, but I haven't ruled out other causes. If the failure persists after a re-run, check the docs sources on the PR branch.

Co-authored-by: MLopez-Ibanez <2620021+MLopez-Ibanez@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix failing GitHub Actions job for documentation build Remove stale Sphinx doctrees cache from Python docs CI job Oct 26, 2026
Copilot AI requested a review from MLopez-Ibanez October 26, 2026 13:27
Co-authored-by: MLopez-Ibanez <2620021+MLopez-Ibanez@users.noreply.github.com>
… conf.py

Co-authored-by: MLopez-Ibanez <2620021+MLopez-Ibanez@users.noreply.github.com>
Co-authored-by: MLopez-Ibanez <2620021+MLopez-Ibanez@users.noreply.github.com>
@codecov

codecov Bot commented Oct 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.41%. Comparing base (b794e4f) to head (375649f).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #89      +/-   ##
==========================================
+ Coverage   77.93%   78.41%   +0.48%     
==========================================
  Files          70       70              
  Lines        7590     7590              
  Branches     1477     1477              
==========================================
+ Hits         5915     5952      +37     
+ Misses       1306     1268      -38     
- Partials      369      370       +1     
Flag Coverage Δ
python 75.78% <ø> (+0.62%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
C 74.83% <ø> (+0.71%) ⬆️
R 81.54% <ø> (ø)
Python tests 100.00% <ø> (ø)
Python src 81.77% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@MLopez-Ibanez
MLopez-Ibanez marked this pull request as ready for review October 26, 2026 18:18
@MLopez-Ibanez
MLopez-Ibanez merged commit 574e5d5 into main Oct 26, 2026
25 checks passed
@MLopez-Ibanez
MLopez-Ibanez deleted the copilot/fix-failing-build-documentation-job branch October 26, 2026 18:21
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