[REDMINE1D-304] [RM-8261] [Doc] Automatically generate parameters documentation from json schema Created: 08/Sep/23  Updated: 14/Nov/23  Resolved: 14/Nov/23

Status: Done
Project: 1D Redmine
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Normal
Reporter: Redmine-Jira Migtation Assignee: Redmine-Jira Migtation
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

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 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.


 Comments   
Comment by Redmine-Jira Migtation [ 14/Nov/23 ]

Comment by Pierre-yves Chabaud on 2023-11-10 10:23:15:
Merged into @develop@ (@7d2195f0@)

Generated at Sat Feb 10 15:31:22 JST 2024 using Jira 8.3.4#803005-sha1:1f96e09b3c60279a408a2ae47be3c745f571388b.