Swimdex

Codex for Swim Strokes

Swimdex is a collection of information about the swim strokes used in both competitive and recreational swimming.

Developing

Swimdex uses mkdocs and nox for development. Use the following to install the necessary tools.

python -m venv .venv
source .venv/bin/activate
pip install -r requirements/dev.in
pip install -r requirements/build.in

Building Documentation

Swimdex can be built locally for development. Use the following to build the site.

mkdocs build
mkdocs serve # to view locally

Releasing Documentation

Swimdex is updated by simply pushing to the docs branch. Use the following to release the site. Note, extra command line arguments cannot be used when running multiple sessions.

nox -s version bump build release
nox -s version bump build release -- --help