From: Andrea Bolognani <abologna@redhat.com>
Date: Thu, 7 May 2020 12:45:03 +0000 (+0200)
Subject: docs: Document list-tables as recommended
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=673cde43d41f80ff5ebda2d35efa94c15556aed1;p=libvirt.git

docs: Document list-tables as recommended

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
---

diff --git a/docs/styleguide.rst b/docs/styleguide.rst
index 3162868fb7..34c5b1573a 100644
--- 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
 ============