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

[DOC] Added all Regressors to the Documentation + small fixes #1660

Closed
wants to merge 2 commits into from

Conversation

Moonzyyy
Copy link
Contributor

What does this implement/fix? Explain your changes.

Fixes #1500, added all the new regressors to the document and changed the page to have all the regressors in alphabetical order for easier readability. Also fixed a spelling mistake in the installation page.

Also added to the CSS file to fix issues arising with Sphinx .autosummary. An issue would happen where the class.rst template would sometimes push the classh definition to the right of the page. This happened due to margin errors of the class.rst template (at least thats what I figured after messing around with it). This addition to the CSS file has not caused any errors elsewhere that contains .autosummary from what I have checked.

Any other comments?

Should specific things such as lists be kept alphabetical or should I ignore this in the future?

[DOC] Added all Regressors to the Documentation
@aeon-actions-bot aeon-actions-bot bot added the documentation Improvements or additions to documentation label Jun 14, 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{#F3B9F8}{\textsf{documentation}}$ ].

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 all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Stop automatic pre-commit fixes (always disabled for drafts)

@MatthewMiddlehurst
Copy link
Member

CI Failure is unrelated, you can merge the most recent main changes.

There appears to be no files changed currently, though.

@Moonzyyy
Copy link
Contributor Author

Oh, that's weird you are right it says no files have been changed. Let me check what happened

@Moonzyyy Moonzyyy closed this Jun 14, 2024
@Moonzyyy Moonzyyy deleted the regression-documentation branch August 15, 2024 10:35
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Update regression API docs
2 participants