IATI Sphinx Theme
How do I use IATI Sphinx Theme?
See the IATI Sphinx Theme Documentation for usage instructions.
If you are creating or editing an IATI documentation site, see the IATI Docs Base for relevant information.
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/ docs/
isort iati_sphinx_theme/ docs/
flake8 iati_sphinx_theme/ docs/
mypy iati_sphinx_theme/ docs/
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-themerepository, and checkout the branch or tag you want to use. -
Run the following command in the
sphinx-themedirectory, to build the CSS for the theme.npm run build -
Go to
my-docsdirectory, and install the Sphinx themepip install -e /path/to/sphinx-theme -
Set the
html_themeoption in yourconf.pyhtml_theme = "iati_sphinx_theme"
-
Start the docs development server:
pip install sphinx-autobuild sphinx-autobuild docs docs/_build/html
Translation
The Sphinx theme itself contains both built-in strings that cannot be changed and strings that can be configured by the user via conf.py. To translate these, see the sphinx-theme documentation
For instructions on translating an IATI documentation site that uses this theme, see the iati-docs-base.
Release process
To publish a new version, raise a PR to main, updating the version in pyproject.toml. Once merged, create a git tag and GitHub release for the new version, with naming vX.Y.Z. This will trigger the package to be published to PyPI.
Release files for iati-sphinx-theme 3.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| iati_sphinx_theme-3.2.0.tar.gz | 347.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| iati_sphinx_theme-3.2.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 707.3 kB
Release files / iati_sphinx_theme-3.2.0.tar.gz
| Download URL | iati_sphinx_theme-3.2.0.tar.gz |
|---|---|
| Size | 347.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
712c4cefd1ebcfb6df97e2b66dcd2195fdda22ca1e6f2e23582689da1198a1f9
|
|
BLAKE2b-256 checksum How to use checksums |
017f7c1ed5ba7c34358cf782177cb10f13fadabfce5c57b75aa1405cfea7c324
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency logRelease files / iati_sphinx_theme-3.2.0-py2.py3-none-any.whl
| Download URL | iati_sphinx_theme-3.2.0-py2.py3-none-any.whl |
|---|---|
| Size | 360.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
b4c8b59880b66cba59b653d3cc32900dbadd9c302cad9c80d38bba5e1f10e0fb
|
|
BLAKE2b-256 checksum How to use checksums |
5204e1d21be17a03d888f57302b053546ba8e64684502731f30273246157785d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency log
