-
Type:
Task
-
Status: Done (View Workflow)
-
Priority:
Normal
-
Resolution: Done
-
Labels:None
Created on 2023-09-07 08:06:57 by Fanny Dufresne. % Done: 100
Automatically generate parameters documentation, and host it
MR: https://gitlab.lam.fr/CPF/cpf-redshift/-/merge_requests/557
Example of the obtained doc : https://cpf.docs.lam.fr/cpf-redshift/test/index.html
Contains:
- CI update to generate documentation hosted on gitlab pages
- A new documentation is created each time a tag is pushed : URL `https://cpf.docs.lam.fr/cpf-redshift/<tag>/json-schema/index.html`
- Documentation is updated each time develop branch is upadted URL : https://cpf.docs.lam.fr/cpf-redshift/develop/json-schema/index.html
- A first version of parameters documentation generated from json schema. The aim here is to validate the documentation flow. The doc layout is imperfect and will be improved after refacto.