Skip to content
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

[ENH] Add sphinx event to add capability table to estimators' docs individually #2468

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

inclinedadarsh
Copy link

@inclinedadarsh inclinedadarsh commented Dec 22, 2024

Reference Issues/PRs

Fixes #1430

What does this implement/fix? Explain your changes.

Add html-page-context callback event to add capabilities table individually to each estimators' docs

  • implement _add_estimator_capabilities_table function
  • use that function with html-page-context sphinx event callback

Does your contribution introduce a new dependency? If yes, which one?

No, it doesn't.

PR checklist

For all contributions
  • I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you.
  • 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.

- add `html-page-context` callback event to add capabilities table individually to each estimators' docs
@aeon-actions-bot aeon-actions-bot bot added the enhancement New feature, improvement request or other non-bug code enhancement label Dec 22, 2024
@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: [ $\color{#FEF1BE}{\textsf{enhancement}}$ ].

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

@inclinedadarsh
Copy link
Author

@all-contributors please add @inclinedadarsh for code

Copy link
Contributor

@inclinedadarsh

I've put up a pull request to add @inclinedadarsh! 🎉

@baraline
Copy link
Member

Seems like the issue was about commit from your side somehow, as merging main fixed it.

One last bit that we should resolve is to have uniform format between what your script generate and the format in the files where capabilities are already listed. I think the simplest would be to remove the existing ones and only keep those generated by the script. Would that be OK for you @SebastianSchmidl ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature, improvement request or other non-bug code enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add individual estimator capabilities in the documentation
2 participants