search

ImperialCollegeLondon / safedata_validator

Python tools to validate and publish datasets using the safedata metadata format.
https://safedata-validator.readthedocs.io/
MIT License
2 stars 4 forks source link

Adding an example file to the documentation #145

Closed jacobcook1995 closed 1 month ago

jacobcook1995 commented 2 months ago

This PR adds an example file and a test to validate that this example file is valid. This example file is then used to populate the documentation. It also defines a hook to generate the command line usage automatically, and a check that these files do not differ from the usage committed to the docs.

This addresses #133 however that issue needs to be kept open because the file download link has to be updated to point to develop (and eventually main). Also once the headers=False issue is fixed some of the code in Summary.md can be simplified.

davidorme commented 2 months ago

This branch is now building on RTD and all looks good: https://safedata-validator.readthedocs.io/en/feature-example_file/data_providers/data_format/overview.html