diff options
-rw-r--r-- | Documentation/getting_started/writing_documentation.md | 14 |
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 |