Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • autosubmit autosubmit
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 338
    • Issues 338
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 21
    • Merge requests 21
  • Deployments
    • Deployments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Earth SciencesEarth Sciences
  • autosubmitautosubmit
  • Merge requests
  • !340

Automate the documentation of Autosubmit variables (for job, platform, and project)

  • Review changes

  • Download
  • Patches
  • Plain diff
Merged Bruno de Paula Kinoshita requested to merge automate-variables-doc into master May 17, 2023
  • Overview 25
  • Commits 8
  • Pipelines 0
  • Changes 13

Closes #951 (closed)

Getting there. This draft produces the rst syntax that looks like the existing code.

image

(top is produced by the directive reading the code, bottom is the written docs text; section is duplicated as I hadn't time to complete that today).

The decorator added in this merge request populates a list of parameters. This list is used by the Sphinx directive to produce the documentation. This part is already unit-tested, 100% covered. The rest of the work before this is ready for review includes:

  • add a decorator to mark the parameters
  • use properties to define parameters
  • generate the three sections with variables for jobs, platforms, and projects, automatically
  • use the same list of parameters and docs to populate the comments in the YAML configuration where these parameters appear
  • add unit tests to the parts changed, or new code
  • make sure RTD rendered output matches the locally generated site - https://autosubmit--340.org.readthedocs.build/en/340/userguide/variables.html
Edited May 24, 2023 by Bruno de Paula Kinoshita
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: automate-variables-doc