Changes for multi-version docs (#668)

* Changes for multi-version docs

* Adding auto-initialisation

* Remove base-url

* Update docs link in README

* Update the version_match string to match the switcher.json map

* Fix doc version matching for movement

* Add blog post about displacement's API changes (#688)

* Add draft for post about displacement's API changes

* remove reference to v0.0.13

Co-authored-by: Niko Sirmpilatze <[email protected]>

* improve phrasing in compute_displacement introduction

Co-authored-by: Niko Sirmpilatze <[email protected]>

* improve wording talking about the PR

Co-authored-by: Niko Sirmpilatze <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* compute_backward_displacement

Co-authored-by: Niko Sirmpilatze <[email protected]>

* improve wording on cart2pol

Co-authored-by: Niko Sirmpilatze <[email protected]>

* blog: change title and add 1-sentence summary

* blog: better explaination of how old implementation worked

* blog: headings changes

* blog: improve suggestion on how to transition to the new API

Co-authored-by: Niko Sirmpilatze <[email protected]>

* update date and headings

* linkcheck ignore BraiAn

---------

Co-authored-by: Niko Sirmpilatze <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Enable pure `pip`/`uv` installations (#683)

* add uv lock to gitignore

* pull tables from pypi instead of conda-forge

* remove tables drom docs requirements.txt

* updated installation guide

* Disable HDF5 file locking in tox

* Revert "Disable HDF5 file locking in tox"

This reverts commit 8173f32.

* updated instruction for creating a dev environment

* remove mamba link from url scheme

* Revert "linkcheck ignore BraiAn"

This reverts commit 7e5a7e0.

* Implement suggestions from PR review

* tweak wording in uv venv instructions

* make linters and linkcheck happy

---------

Co-authored-by: carlocastoldi <[email protected]>
Co-authored-by: Niko Sirmpilatze <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 4 people

.github/workflows/docs_build_and_deploy.yml

@@ -56,7 +56,8 @@ jobs:
       (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main')
     runs-on: ubuntu-latest
     steps:
-      - uses: neuroinformatics-unit/actions/deploy_sphinx_docs@main
+      - uses: neuroinformatics-unit/actions/deploy_sphinx_docs_multiversion@main
         with:
           secret_input: ${{ secrets.GITHUB_TOKEN }}
           use-make: true
+          switcher-url: https://movement.neuroinformatics.dev/latest/_static/switcher.json

README.md

@@ -28,7 +28,7 @@ conda activate movement-env
 
 
 > [!Note]
-> Read the [documentation](https://movement.neuroinformatics.dev) for more information, including [full installation instructions](https://movement.neuroinformatics.dev/user_guide/installation.html) and [examples](https://movement.neuroinformatics.dev/examples/index.html).
+> Read the [documentation](https://movement.neuroinformatics.dev/latest) for more information, including [full installation instructions](https://movement.neuroinformatics.dev/latest/user_guide/installation.html) and [examples](https://movement.neuroinformatics.dev/latest/examples/index.html).
 
 ## Overview
 
@@ -46,7 +46,7 @@ motion tracks, enabling steps such as data cleaning, visualisation,
 and motion quantification. We aim to support all popular animal tracking
 frameworks and file formats.
 
-Find out more on our [mission and scope](https://movement.neuroinformatics.dev/community/mission-scope.html) statement and our [roadmap](https://movement.neuroinformatics.dev/community/roadmaps.html).
+Find out more on our [mission and scope](https://movement.neuroinformatics.dev/latest/community/mission-scope.html) statement and our [roadmap](https://movement.neuroinformatics.dev/latest/community/roadmaps.html).
 
 <!-- Start Admonitions -->
 
@@ -61,7 +61,7 @@ Find out more on our [mission and scope](https://movement.neuroinformatics.dev/c
 ## Join the movement
 
 Contributions to movement are absolutely encouraged, whether to fix a bug, develop a new feature, or improve the documentation.
-To help you get started, we have prepared a detailed [contributing guide](https://movement.neuroinformatics.dev/community/contributing.html).
+To help you get started, we have prepared a detailed [contributing guide](https://movement.neuroinformatics.dev/latest/community/contributing.html).
 
 - [Chat with the team on Zulip](https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement).
 - [Open an issue](https://github.com/neuroinformatics-unit/movement/issues) to report a bug or request a new feature.

docs/source/conf.py

@@ -31,6 +31,8 @@
     # with a dummy version
     release = "0.0.0"
 
+doc_version = "dev" if "dev" in release else f"v{release}"
+
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
@@ -150,9 +152,14 @@
             "type": "fontawesome",
         },
     ],
+    "switcher": {
+        "json_url": "https://movement.neuroinformatics.dev/latest/_static/switcher.json",
+        "version_match": doc_version,
+    },
     "logo": {
         "text": f"{project} v{release}",
     },
+    "navbar_end": ["version-switcher", "navbar-icon-links"],
     "footer_start": ["footer_start"],
     "footer_end": ["footer_end"],
     "external_links": [],
@@ -191,6 +198,7 @@
     "https://opensource.org/license/bsd-3-clause/",  # to avoid odd 403 error
     "https://www.sainsburywellcome.org/",  # Occasional ConnectTimeoutError
     "https://www.robots.ox.ac.uk/",  # occasional 404s
+    "https://silvalab.codeberg.page/BraiAn/",  # SSLError despite working link
 ]