Skip to content

Commit

Permalink
Update CONTRIBUTING.md with docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
talmo committed Jun 6, 2024
1 parent d857684 commit aaeb0f2
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,20 +166,21 @@ Valid examples:
```

### Build
The PyPI-compatible package settings are in [pyproject.toml].
The PyPI-compatible package settings are in [`pyproject.toml`](pyproject.toml).

The version number is set in [sleap_io/version.py] in the `__version__` variable. This is read automatically by setuptools during installation and build.
The version number is set in [`sleap_io/version.py`](sleap_io/version.py) in the `__version__` variable. This is read automatically by setuptools during installation and build.

To manually build (e.g., locally):
```
python -m build --wheel
```

To trigger an automated build (via the [.github/workflows/build.yml] action), [publish a Release](https://github.com/talmolab/sleap-io/releases/new).
To trigger an automated build (via the [`.github/workflows/build.yml`](.github/workflows/build.yml) action), [publish a Release](https://github.com/talmolab/sleap-io/releases/new).


## Documentation website

1. Install with the `dev` dependencies (e.g., `pip install -e ".[dev]")
2. Preview live changes with `mkdocs serve`
3. Manually push a specific version with: `mike deploy --push --update-aliases 0.1.0 latest`
1. Install `sleap-io` with the `dev` dependencies (e.g., `pip install -e ".[dev]"`). This is the default when installing from source via conda (`conda env create -f environment.yml`).
2. Build and tag a new version of the docs: `mike deploy --update-aliases 0.1.4 latest`
3. Preview live changes locally with: `mike serve`
4. Manually push a specific version with: `mike deploy --push --update-aliases --allow-empty 0.1.4 latest`

0 comments on commit aaeb0f2

Please sign in to comment.