Skip to content

docs: align SciPy lower bound with package metadata#572

Merged
igerber merged 1 commit into
igerber:mainfrom
shawcharles:fix/scipy-floor-docs
Jun 29, 2026
Merged

docs: align SciPy lower bound with package metadata#572
igerber merged 1 commit into
igerber:mainfrom
shawcharles:fix/scipy-floor-docs

Conversation

@shawcharles

Copy link
Copy Markdown
Contributor

Summary

  • Align README, Read the Docs, and docs CI SciPy lower-bound references with pyproject.toml's scipy>=1.10 runtime requirement.
  • Leave normal test workflows that install latest scipy unchanged.
  • Wrap DID_+, DID_-, and DID_M as inline code in the dCDH tutorial so the Sphinx -W docs build does not treat the underscores as unresolved reference targets.

Closes #571.

Methodology references (required if estimator / math changes)

  • Method name(s): N/A - documentation and docs-CI dependency metadata only
  • Paper / source link(s): N/A
  • Any intentional deviations from the source (and why): N/A

Validation

  • Tests added/updated: N/A - no runtime behaviour change
  • Backtest / simulation / notebook evidence (if applicable): N/A
  • Commands run:
    • rg -n 'scipy\\s*>?=\\s*1\\.7|scipy>=1\\.7' README.md .readthedocs.yaml .github docs pyproject.toml returned no matches
    • Python 3.9 docs dependency install smoke passed in a temporary venv; resolved scipy 1.13.1, sphinx 7.4.7, pydata-sphinx-theme 0.16.1, nbsphinx 0.9.8
    • PYTHONPATH=. DIFF_DIFF_BACKEND=python pytest tests/test_doc_snippets.py tests/test_doc_deps_integrity.py -q passed: 265 passed, 4 skipped
    • make -C docs html SPHINXOPTS=\"-W\" passed

Security / privacy

  • Confirm no secrets/PII in this PR: Confirmed

@shawcharles

shawcharles commented Jun 28, 2026

Copy link
Copy Markdown
Contributor Author

A quick note to say that this PR is ready for CI when you have a moment to add the ready-for-ci label.

Local validation passed:

  • search guard found no remaining active scipy>=1.7 lower-bound claims
  • Python 3.9 docs dependency install smoke passed
  • PYTHONPATH=. DIFF_DIFF_BACKEND=python pytest tests/test_doc_snippets.py tests/test_doc_deps_integrity.py -q passed: 265 passed, 4 skipped
  • make -C docs html SPHINXOPTS="-W" passed

@igerber igerber added the ready-for-ci Triggers CI test workflows label Jun 29, 2026
@igerber igerber merged commit 491b8d5 into igerber:main Jun 29, 2026
30 of 31 checks passed
@igerber igerber mentioned this pull request Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-ci Triggers CI test workflows

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Align documented SciPy lower bound with package metadata

2 participants