docs: Document list-tables as recommended

Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2024-12-22 05:35:25 +00:00 · 2020-05-07 14:45:03 +02:00 · 2020-05-07 14:45:03 +02:00 · 673cde43d4
commit 673cde43d4
parent f42be8a2ef
1 changed files with 20 additions and 0 deletions
--- a/docs/styleguide.rst
+++ b/docs/styleguide.rst
@ -77,6 +77,26 @@ which allows for 6 levels of headings
   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
 ============