[libvirt PATCH 2/2] docs: Document list-tables as recommended

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Signed-off-by: Andrea Bolognani <abologna@xxxxxxxxxx>
---
 docs/styleguide.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

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
 ============
 
-- 
2.25.4





[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]

  Powered by Linux