Skip to content

Commit

Permalink
Update movement website refs to internal file refs
Browse files Browse the repository at this point in the history
  • Loading branch information
lochhh committed Nov 6, 2023
1 parent f1363b0 commit eee216f
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 6 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ The version number is automatically determined from the latest tag on the _main_
## Contributing documentation

The documentation is hosted via [GitHub pages](https://pages.github.com/) at
[movement.neuroinformatics.dev](movement-website:).
[movement.neuroinformatics.dev](../index.md).
Its source files are located in the `docs` folder of this repository.
They are written in either [reStructuredText](https://docutils.sourceforge.io/rst.html) or
[markdown](myst-parser:syntax/typography.html).
Expand Down Expand Up @@ -189,7 +189,7 @@ If it is not yet defined and you have multiple external links pointing to the sa
### Updating the API reference
If your PR introduces new public-facing functions, classes, or methods,
make sure to add them to the `docs/source/api_index.rst` page, so that they are
included in the [API reference](movement-website:api_index),
included in the [API reference](../api_index.rst),
e.g.:

```rst
Expand All @@ -208,7 +208,7 @@ that follow the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html

### Updating the examples
We use [sphinx-gallery](sphinx-gallery:)
to create the [examples](movement-website:examples).
to create the [examples](../examples/index.rst).
To add new examples, you will need to create a new `.py` file in `examples/`.
The file should be structured as specified in the relevant
[sphinx-gallery documentation](sphinx-gallery:syntax).
Expand Down
2 changes: 1 addition & 1 deletion docs/source/community/mission-scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Mission

[movement](movement-website:) aims to **facilitate the study of animal behaviour in neuroscience** by providing a suite of **Python tools to analyse body movements** across space and time.
[movement](../index.md) aims to **facilitate the study of animal behaviour in neuroscience** by providing a suite of **Python tools to analyse body movements** across space and time.

## Scope

Expand Down
2 changes: 1 addition & 1 deletion docs/source/community/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ We plan to release version `v0.1` of movement in early 2024, providing a minimal
- Visualisation of pose tracks using [napari](napari:). We aim to represent pose tracks via the [napari tracks layer](napari:howtos/layers/tracks) and overlay them on a video frame. This should be accompanied by a minimal GUI widget to allow selection of a subset of the tracks to plot. This line of work is still in a pilot phase. We may decide to use a different visualisation framework if we encounter roadblocks.
- At least one function for cleaning the pose tracks. Once the first one is in place, it can serve as a template for others.
- Computing velocity and acceleration from pose tracks. Again, this should serve as a template for other kinematic variables.
- Package release on PyPI and conda-forge, along with documentation. The package is already available on [PyPI](https://pypi.org/project/movement/) and the [documentation website](movement-website:) is up and running. We plan to also release it on conda-forge to enable one-line installation.
- Package release on PyPI and conda-forge, along with documentation. The package is already available on [PyPI](https://pypi.org/project/movement/) and the [documentation website](../index.md) is up and running. We plan to also release it on conda-forge to enable one-line installation.
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,6 @@
"ftp": None,
"mailto": None,
"movement-github": "https://github.com/neuroinformatics-unit/movement/{{path}}",
"movement-website": "https://movement.neuroinformatics.dev/{{path}}",
"movement-zulip": "https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement/topic/Welcome!",
"conda": "https://docs.conda.io/en/latest/",
"dlc": "https://www.mackenziemathislab.org/deeplabcut/",
Expand Down

0 comments on commit eee216f

Please sign in to comment.