shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-09 01:18:00 +03:00
Code Releases Activity

docs: Document list-tables as recommended

Browse Source 
Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Andrea Bolognani 2020-05-07 14:45:03 +02:00
parent f42be8a2ef
commit 673cde43d4
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/styleguide.rst
View File

@ -77,6 +77,26 @@ which allows for 6 levels of headings
Heading 6 Heading 6
^^^^^^^^^ ^^^^^^^^^
Tables
======
Tables should be created using the ``list-table`` directive whenever
possible, as in
::
.. list-table::
:header-rows: 1
* - Option
- Description
* - ``foo_enabled``
- Whether or not ``foo`` should be enabled
* - ``bar_user``
- Which user to run ``bar`` as
Manual pages Manual pages
============ ============