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
2 changes: 1 addition & 1 deletion .github/workflows/docs_build_and_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
~/.movement/*
key: cached-test-data-${{ runner.os }}
restore-keys: cached-test-data
- uses: neuroinformatics-unit/actions/build_sphinx_docs@main
- uses: neuroinformatics-unit/actions/build_sphinx_docs@build-docs-group-dep
with:
python-version: 3.13
use-make: true
Expand Down
4 changes: 2 additions & 2 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ source .venv/bin/activate # On macOS and Linux
.venv\Scripts\activate # On Windows PowerShell

# Install in editable mode with dev dependencies
uv pip install -e ".[dev]"
uv pip install -e . --group dev

# Install pre-commit hooks
pre-commit install
Expand Down Expand Up @@ -61,7 +61,7 @@ mypy movement
### Documentation
```bash
# Install documentation dependencies
pip install -e ".[docs]"
uv pip install -e . --group docs

# Build documentation (from docs/ directory)
cd docs
Expand Down
18 changes: 12 additions & 6 deletions docs/source/community/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Now that you have the repository locally, you need to set up a Python environmen
Then, install the package in editable mode with development dependencies:

```sh
pip install -e ".[dev]"
pip install -e . --group dev
```
:::

Expand All @@ -93,12 +93,18 @@ Now that you have the repository locally, you need to set up a Python environmen
Then, install the package in editable mode with development dependencies:

```sh
uv pip install -e ".[dev]"
uv pip install -e . --group dev
```
:::

::::
If you also want to edit the documentation and preview the changes locally, you will additionally need the `docs` extra dependencies. See [Editing the documentation](#editing-the-documentation) for more details.
If you also want to [edit the documentation](#editing-the-documentation) and preview the changes locally, you will additionally need the `docs` dependencies.
To install both `dev` and `docs` dependencies at once, use the `all` group:

```sh
pip install -e . --group all # conda env
uv pip install -e . --group all # uv env
```

2. Finally, initialise the [pre-commit hooks](#formatting-and-pre-commit-hooks):

Expand Down Expand Up @@ -602,10 +608,10 @@ This keeps the documentation aligned with releases, while allowing manual redepl
### Editing the documentation
To edit the documentation, ensure you have already set up a [development environment](#creating-a-development-environment).

To build the documentation locally, install the extra dependencies by running the following command from the repository root:
To build the documentation locally, install the `docs` dependencies by running the following command from the repository root:
```sh
pip install -e ".[docs]" # conda env
uv pip install -e ".[docs]" # uv env
pip install -e . --group docs # conda env
uv pip install -e . --group docs # uv env
```

Now create a new branch, edit the documentation source files (`.md` or `.rst` in the `docs` folder),
Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ entry-points."napari.manifest".movement = "movement.napari:napari.yaml"

[project.optional-dependencies]
napari = ["napari[all]>=0.6.0"]

[dependency-groups]
all = [{include-group = "dev"}, {include-group = "docs"}]
dev = [
"pytest",
"pytest-cov",
Expand Down Expand Up @@ -215,7 +218,7 @@ passenv =
XAUTHORITY
NUMPY_EXPERIMENTAL_ARRAY_FUNCTION
PYVISTA_OFF_SCREEN
extras =
dependency_groups =
dev
commands =
pytest -v --color=yes --cov=movement --cov-report=xml
Expand Down
Loading