IATI Reference Generator

A repository which combines all IATI Standard Single Source of Truth documentation-generating code into a single location. In general, Python code is run to create RST files, RST files are parsed with Sphinx to generate HTML files, and HTML files are cleaned for import into our Wagtail website IATI-Standard-Website.

Setup

Ensure Python 3 and the virtualenv package are installed globally on your machine.

To clone, use the --recurse-submodules flag, e.g.

git clone --recurse-submodules https://github.com/IATI/IATI-Reference-Generator.git

To update submodules:

git submodule update --recursive --remote

To run

./build.sh

This will create the following primary outputs within the repository:

• venv: If it didn't already exist, the Python3 virtual environment folder
• output: A folder of cleaned HTML output
• output.zip: A zip of the above folder
• downloads: Static files to accompany the cleaned HTML
• downloads.zip: A zip of the above folder

Some diagnostic files are also created as a result of the process, they include:

• class_dict.json: A nested data structure showing the class names of HTML elements within each file. This is used to ensure classes from the HTML output will be appropriately styled on the IATI Standard Website.
• href_list.csv: A spreadsheet of links used within the output HTML, to help avoid broken links.
• unknown_words.csv: A spreadsheet of words that a standard Python dictionary thinks may be misspelled to avoid typos.