A sphinx theme for IATI documentation sites.
Project description
IATI Sphinx Theme
How do I use IATI Sphinx Theme?
Please see the IATI Sphinx Theme Documentation for usage instructions.
How do I contribute to IATI Sphinx Theme?
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/
Testing a local version of the theme against another project
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 themepip install -e /path/to/sphinx-theme
-
Set the
html_theme
option in yourconf.py
html_theme = "iati_sphinx_theme"
-
Start the docs development server:
pip install sphinx-autobuild sphinx-autobuild docs docs/_build/html
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
Hashes for iati_sphinx_theme-1.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c926570b4a278b1bd204d93ecae8ce2449a53f6a175ae643552856b8bd702ce2 |
|
MD5 | d5e1d7f286ef8da94c3f14d78ae8df82 |
|
BLAKE2b-256 | c148a3b90dbe358a401957c80de3dadae01308a0fd2b110aa6c54f68b542cf9b |