Please see the IATI Sphinx Theme Documentation for usage instructions.
pip install -r requirements_dev.txt
python -m piptools compile --extra=dev -o requirements_dev.txt pyproject.toml
pip install -r requirements_dev.txt
black iati_sphinx_theme/
isort iati_sphinx_theme/
flake8 iati_sphinx_theme/
mypy iati_sphinx_theme/
In one terminal, build the CSS in watch mode
npm run build:watch
In a separate terminal, install the Sphinx theme then start the docs development server:
pip install -e .
sphinx-autobuild -a docs docs/_build/html --watch iati_sphinx_theme/
To run a local version of the theme with another project, e.g. my-docs
, take the following steps:
Clone the sphinx-theme
repository, and checkout the branch or tag you want to use.
Run the following command in the sphinx-theme
directory, to build the CSS for the theme.
npm run build
Go to my-docs
directory, and install the Sphinx theme
pip install -e /path/to/sphinx-theme
Set the html_theme
option in your conf.py
html_theme = "iati_sphinx_theme"
Start the docs development server:
pip install sphinx-autobuild
sphinx-autobuild docs docs/_build/html