The one place for your designs
To enable design management, you'll need to meet the requirements. If you need help, reach out to our support team for assistance.
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>
<descriptionis added.
Proposal
- Adjust the Python RST writer to insert the appropriate Sphinx directives based on the
Parameterattributes.
How to test the implementation?
Inspection of the deployed documentation.
Related issues
Meta-issue: #164 (closed)