A sphinx theme for IATI documentation sites.
Project description
IATI Sphinx Theme
Development
Install dependencies
pip install -r requirements_dev.txt
Update dependencies
python -m piptools compile --extra=dev -o requirements_dev.txt pyproject.toml
pip install -r requirements_dev.txt
Run linting
black iati_sphinx_theme/
isort iati_sphinx_theme/
flake8 iati_sphinx_theme/
mypy iati_sphinx_theme/
Documentation with live preview
-
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/
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for iati_sphinx_theme-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99947344488b3dbc64e83d22dda7c262380f07d8600bbbb899ca83fd8191817f |
|
MD5 | d8da479ecba8d818f8de282cadb6a145 |
|
BLAKE2b-256 | 862dd8b382df35c60f6cccfc852b92b12a6618a4054f441eb867dfac5d25cc9d |