From 1e742217e6061a95376318525df45a872f049f07 Mon Sep 17 00:00:00 2001 From: Patrick Rudolph Date: Tue, 9 Apr 2019 14:12:55 +0200 Subject: 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 Reviewed-on: https://review.coreboot.org/c/coreboot/+/32251 Tested-by: build bot (Jenkins) Reviewed-by: Paul Menzel --- Documentation/getting_started/writing_documentation.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'Documentation/getting_started') diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md index 4faec1800e53..fb942a426eac 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 -- cgit v1.2.3