Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/docs_build_and_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 -->

Expand All @@ -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.
Expand Down
10 changes: 10 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@
# with a dummy version
release = "0.0.0"

if "dev" in release:
doc_version = "dev"
else:
doc_version = f"v{release}"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

Expand Down Expand Up @@ -150,9 +155,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": [],
Expand Down
Loading