IATI Validator Docs

Deployed to https://docs.validator.iatistandard.org/en/latest/

Docs should build automatically upon pull request.

Features of the docs

Uses https://github.com/OpenDataServices/sphinx-base, but without markdown or json support. See the examples and kitchen sink sections for some directives you can use.

Extra features:

• Wrapping text in tables, to avoid having horizontal scrollbars
• Extra directives you can use, thanks to our extensions, see the docs of those for more information: - https://sphinxcontrib-opendataservices.readthedocs.io/en/latest/

Build the docs locally

Assuming a unix based system:

# Make sure you have python3 venv, e.g. for Ubuntu
# If you're not sure, try creating a venv, and see if it errors
sudo apt-get install python3-venv

# Create a venv
python3 -m venv .ve

# Enter the venv, needs to be run for every new shell
source .ve/bin/activate

# Install requirements
pip install -r requirements.txt

# Build the docs
cd docs
make dirhtml

Built docs are in docs/_build/dirhtml.

Viewing the docs:

cd _build/dirhtml
python -m http.server

Then go to http://localhost:8000/ in a browser.

Translations

Install requirements as above.

Extract English source strings:

cd docs
make gettext
# .pot files are in _build/locale

Then put the translated files in docs/locale/fr/LC_MESSAGES/.

Build a translated docs site:

cd docs
make -e SPHINXOPTS="-D language='fr'" dirhtml

Built docs are in docs/_build/dirhtml.