Skip to content

GitLab

The TS-GitLab will have to shut down in the near future — please plan migrating your projects to GitLab.com or GitHub. Contact @yunus for more information.

Closed
Created by Lukas Riedel@lriedel🎧Owner

Add XML version tags to config file parameter docs

Description

With #165 (closed) and #166 (closed) resolved, we can now plug the two new features together.

Display the version information stored in the dictionary attributes of Parameter in the config file parameter docs. This means that for any entry in the attributes like

class Parameter:
    self.versionchanged = { "<ver>": "<description>" }

a section in the written RST like

.. object:: <Parameter>

   .. versionchanged: <ver>
      <description

is added.

Proposal

  • Adjust the Python RST writer to insert the appropriate Sphinx directives based on the Parameter attributes.

How to test the implementation?

Inspection of the deployed documentation.

Related issues

Meta-issue: #164 (closed)

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information