ucam-department-of-psychiatry / crate

Create and use de-identified research databases. Preprocess, extract text, anonymise/de-identify, link, apply natural language processing, query for research, manage consent for contact.
GNU General Public License v3.0
19 stars 7 forks source link

Documentation fixes and a GitHub action to build report faulty/missing/changed documents; #65

Closed martinburchell closed 2 years ago

martinburchell commented 2 years ago

I've changed the Sphinx build to treat warnings as errors and fixed all of the errors. The Django templates should now be rendered with syntax highlighting. Currently the code assumes that any file ending in .html is a Django template.

The GitHub action builds the documentation from scratch and reports any errors or differences between the generated files and those in the repository.

This should help prevent the documentation from lagging behind the code.