summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Rudolph <patrick.rudolph@9elements.com>2019-04-09 14:12:55 +0200
committerPatrick Georgi <pgeorgi@google.com>2019-04-11 11:21:05 +0000
commit1e742217e6061a95376318525df45a872f049f07 (patch)
treeffe8c1183b8507202cadd4927aa0b49bcf722ce9
parentbff6dc7b8c1e18921c36b51eaad76d46d674f466 (diff)
Documentation: Allow the use of CSV
Allow the use of CSV files if properly referenced from markdown. Sphinx will parse the file and create a human readable table, allowing easy integration of autogenerated files. Change-Id: I6fa13acf67ff1c6c9e3985054405c5446808da03 Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/32251 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
-rw-r--r--Documentation/getting_started/writing_documentation.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md
index 4faec1800e..fb942a426e 100644
--- a/Documentation/getting_started/writing_documentation.md
+++ b/Documentation/getting_started/writing_documentation.md
@@ -100,6 +100,20 @@ If you do only reference the document, but do not include it in any toctree,
you'll see the following warning:
**WARNING: document isn't included in any toctree**
+## CSV
+
+You can import CSV files and let sphinx automatically convert them to human
+readable tables, using the following reStructuredText snipped:
+
+ ```eval_rst
+ .. csv-table::
+ :header: "Key", "Value"
+ :file: keyvalues.csv
+ ```
+
+Of course this can only be done from a markdown file that is included in the
+TOC tree.
+
[coreboot]: https://coreboot.org
[Documentation]: https://review.coreboot.org/cgit/coreboot.git/tree/Documentation
[shpinx-autobuild]: https://github.com/GaretJax/sphinx-autobuild