Uploaded image for project: '1D Redmine '
  1. 1D Redmine
  2. REDMINE1D-304

[RM-8261] [Doc] Automatically generate parameters documentation from json schema

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Done (View Workflow)
    • Priority: Normal
    • Resolution: Done
    • Labels:
      None

      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.

        Attachments

          Activity

            People

            • Assignee:
              r2j.migrate Redmine-Jira Migtation
              Reporter:
              r2j.migrate Redmine-Jira Migtation
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: