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
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
  • dorie
  • dorie
  • Issues
  • #165

Closed
Open
Opened Oct 04, 2019 by Lukas Riedel@lriedelOwner

Reformat config file parameter docs into list/objects

Description

The documentation currently displays config file parameters in a table. Because the descriptions are quite long, this table crops out of the frame and has to be scrolled to read all information. This is somewhat annoying and cannot incorporate any further data one might like to add.

Screen_Shot_2019-10-04_at_15.47.56

Proposal

Rewrite the rst.py Python module to format paramters differently. Instead of a table, we can use an object directive for each parameter. The additional information can then be listed instead of cramped into a table.

My template proposal:


Category: ``<cat1>.<cat2>``
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. object:: maxLevel

   Description goes here.

   .. list-table::
      :widths: auto

      * - Possible values
        - ``int``
      * - Default value
        - 10
      * - Queried at
        - | <Location1>
          | <Location2>

In use, this would render as

Screen_Shot_2019-10-04_at_16.06.53

How to test the implementation?

No tests needed. Just look at the resulting documentation to verify.

Related issues

Meta-issue: #164 (closed)

Edited Oct 07, 2019 by Lukas Riedel
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
Reference: dorie/dorie#165