sphinx-seibootcamps

A Sphinx extension that includes all the things you want while supporting customizations.

Installing for development

If you'll only be working on the Sphinx extension, you're only required to follow the instructions under Install Python dependencies, then skip ahead to Install git hooks. If you'll be doing SCSS development, you'll need to follow all sets of instructions, including Install Node dependencies.

Install Python dependencies

Environments managed by Poetry and virtualenv are supported, but using Poetry is strongly recommended.

Install dependencies using your favorite package manager.

poetry install

# or, with virtualenv
virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt

Install Node dependencies

Using yarn:

yarn install

Install git hooks

Then, install pre-commit hooks.

poetry run pre-commit install

# or, after activing your virtual env
pre-commit install