Schema and codelist documentation generator

[duncandewhurst]

Description

A Python application that generates Markdown documentation for a JSON Schema and CSV codelists.
The schema documentation features a section for each definition in the schema including its description, fields and referencing properties.

The codelist documentation features a section for codelist including its codes and referencing properties.

To ensure that documentation stays in sync with schema changes, the tool can be run as part of a pre-commit command in an admin CLI, e.g. manage.py pre-commit.

Implmentations

• OFDS schema reference and codelist reference documentation
• RDLS schema reference and codelist reference documentation
• OC4IDS schema reference documentation