Repository navigation
[BUG] Keep the generated estimator overview in the documentation directory - #4002
hector2394 wants to merge 1 commit into
Conversation
Keep root-launched Sphinx builds from writing an unused table or rendering stale documentation. Co-authored-by: Tony Bagnall <a.j.bagnall@soton.ac.uk>
Thank you for contributing to
|
Reference Issues/PRs
Refs #3959 and #3964.
What does this implement/fix? Explain your changes.
Resolve the generated estimator overview table relative to
docs/conf.py. Launching Sphinx from the repository root then updates the file included by the overview page, instead of writing a separate root file and failing on a clean checkout or silently rendering an old table.Add four regression cases covering root/docs launch directories with absent or stale tables. Each checks fresh content in docs and the absence of a stray root file. Document that the table is regenerated during the build.
This is the path prerequisite suggested in the review of #3964. It does not implement the other documentation-validation work in #3959.
Does your contribution introduce a new dependency? If yes, which one?
No.
Any other comments?
Local validation on Windows with Python 3.12.13:
python -m pytest aeon/testing/tests/test_doc_config.py aeon/testing/tests/test_api_reference.py aeon/utils/tests/test_discovery.py -q -p no:cacheprovider: 34 passed.pre-commit run --files docs/conf.py docs/estimator_overview.md aeon/testing/tests/test_doc_config.py --show-diff-on-failure: all applicable hooks passed.The full root-launched Sphinx build completed HTML generation on a cached retry after a ten-minute timeout. Its strict check exited 1 with 243 warnings, including autosummary import warnings outside the changed files. The generated overview HTML contains the fresh table and the new note, and no table appears at the repository root. A clean strict full-site build is not passing. The full estimator suite and package builds were not run for this documentation-generation change.
PR checklist
For all contributions
This pull request includes code written with the assistance of AI.
The code has been reviewed by a human.