Skip to content

[DOC,MNT] Documentation configuration clean-up #2911

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 13 commits into
base: main
Choose a base branch
from

Conversation

MatthewMiddlehurst
Copy link
Member

@MatthewMiddlehurst MatthewMiddlehurst commented Jun 18, 2025

  • Fixes changelog and docstring typos
  • Adds GSoC mentees to the funding section
  • Tidies up the conf.py into sections and removes some useless attributes (from removed/deprecated extensions). Adds more comments such as where the config option is from and what they do
  • Removes the manual and Latex configuration. I dont think anyone uses this and it can be easily added back. It seems like clutter in an already difficult to understand file for newcomers
  • Add option to show which classes an estimator inherits in the API

Old:
image
New:
image

  • Adds config to remove some useless functions we inherit from the API page i.e. get_metadata_routing used by scikit-learn

Old:
image
New:
image

  • Moves the binder badge from the top of examples to the bottom

Old:
image
image
New:
image
image

@aeon-actions-bot aeon-actions-bot bot added classification Classification package documentation Improvements or additions to documentation maintenance Continuous integration, unit testing & package distribution networks Networks package labels Jun 18, 2025
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ documentation, maintenance ].
I have added the following labels to this PR based on the changes made: [ classification, networks ]. 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, any trivial fixes will automatically be pushed to your PR unless it is a draft.

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

PR CI actions

These checkboxes will add labels to enable/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
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Disable numba cache loading
  • Push an empty commit to re-run CI checks

@MatthewMiddlehurst MatthewMiddlehurst removed classification Classification package networks Networks package labels Jun 23, 2025
@MatthewMiddlehurst MatthewMiddlehurst marked this pull request as ready for review June 23, 2025 21:20
@MatthewMiddlehurst
Copy link
Member Author

This may come with some unintended side effects. Keep an eye out, but from what I checked there is nothing off.

hadifawaz1999
hadifawaz1999 previously approved these changes Jun 23, 2025
Copy link
Member

@hadifawaz1999 hadifawaz1999 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Continuous integration, unit testing & package distribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants