[DOC] Distance function notebook #2395

[kevinzb56]

Reference Issues/PRs

See #2395

What does this implement/fix? Explain your changes.

The notebook distances.ipyb is very nice, but there is a lot more now in the distances module, and it would be good to easily navigate between top page and sub pages:

1. Add a top page distances
2. Add sub pages for elastic, mindist, pointwise and "others"

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

No

Any other comments?

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 after the PR has been merged.
• 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.

For new estimators and functions

• I've added the estimator/function to the online API documentation.
• (OPTIONAL) I've added myself as a __maintainer__ at the top of relevant files and want to be contacted regarding its maintenance. Unmaintained files may be removed. This is for the full file, and you should not add yourself if you are just making minor changes or do not want to help maintain its contents.

For developers with write access

• (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[aeon-actions-bot]

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#45FD64}{\textsf{examples}}$ ]. 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

[SebastianSchmidl]

@kevinzb56 there are no new pages describing the new distances in this PR. Did you forget to add and commit them?

[kevinzb56]

@SebastianSchmidl I’ve added the navigation buttons for the top page and the subpages. Are there any new distances I should include or update? Thanks

[MatthewMiddlehurst]

Agreed this does not resolve the issue. The request is to add new notebooks for the different types of distances now available in the module and then a top-level notebook linking summarising and linking to them. The current notebook mainly focuses on elastic distances.

As a side note having a ToC is fine, but i wouldnt add "Back to Navigation" in every section.

[kevinzb56]

Regarding the "Back to Navigation" button, I’ll remove it from the individual sections as per your suggestion. The current module has elastic, mindist, and pointwise distances. Please let me know if I missed anything or if there are further details to address.

[TonyBagnall]

I think its good to have a ToC, but as mentioned this does not fix the issue, so I have edited the automatic issue closer. Still useful though, thanks!

[TonyBagnall]

happy to merge this if you remove the back to navigation

[kevinzb56]

@TonyBagnall I have removed the 'Back to Navigation' from all sections as requested. Kindly review the changes at your convenience. Thank you!

[SebastianSchmidl]

Read-the-docs automatically creates a TOC in a sidebar. So, having it in the content is not really necessary. But I am not against this.

LGTM!