Skip to content

[BUG] Keep the generated estimator overview in the documentation directory - #4002

Open
hector2394 wants to merge 1 commit into
aeon-toolkit:mainfrom
hector2394:fix/docs-estimator-overview-path
Open

hector2394 wants to merge 1 commit into
aeon-toolkit:mainfrom
hector2394:fix/docs-estimator-overview-path

Conversation

@hector2394

Copy link
Copy Markdown

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:

  • New regression cases on the original generator: 2 failed, 2 passed.
  • 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.
  • Final regression file after formatting: 4 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.
  • Four focused Sphinx HTML builds with the actual configuration callbacks and real estimator discovery pass with warnings treated as errors. Generated Markdown is identical across clean/stale and root/docs cases.

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
  • I've added myself to the list of contributors.
  • The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.

This pull request includes code written with the assistance of AI.
The code has been reviewed by a human.

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>
@aeon-actions-bot aeon-actions-bot Bot added bug Something isn't working testing Testing related issue or pull request labels Nov 10, 2026
@aeon-actions-bot

Copy link
Copy Markdown
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: bug.
I have added the following labels to this PR based on the changes made: testing. Feel free to change these if they do not properly represent the PR.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, please run pre-commit locally and push the fixes to your PR branch.

Don't hesitate to ask questions on the aeon Discord channel if you have any.

PR CI actions

These checkboxes will add labels to enable or disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • Run pre-commit checks for all files
  • Run mypy typecheck tests
  • Run all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Disable numba cache loading
  • Regenerate expected results for testing
  • Push an empty commit to re-run CI checks

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working testing Testing related issue or pull request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant