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.
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.
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
How to test the implementation?
No tests needed. Just look at the resulting documentation to verify.
Related issues
Meta-issue: #164 (closed)