Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
D
dorie
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 31
    • Issues 31
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 9
    • Merge Requests 9
  • Operations
    • Operations
    • Incidents
    • Environments
  • Analytics
    • Analytics
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar

The TS-GitLab will have to shut down towards the end of the year — please think about migrating your projects to GitLab.com or GitHub.
(This is still a very early message, meant to keep you informed. There will be more urgent ones in the future.)

  • dorie
  • dorie
  • Issues
  • #167

Closed
Open
Created Oct 07, 2019 by Lukas Riedel@lriedelOwner

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
Assignee
Assign to
v2.0 Release
Milestone
v2.0 Release
Assign milestone
Time tracking
None
Due date
None