Patrick Rudolph has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/32251
Change subject: Documentation: Allow the use of CSV ......................................................................
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 --- M Documentation/getting_started/writing_documentation.md 1 file changed, 14 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/51/32251/1
diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md index 0ba17e3..ac425ef 100644 --- a/Documentation/getting_started/writing_documentation.md +++ b/Documentation/getting_started/writing_documentation.md @@ -100,6 +100,20 @@ 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
Paul Menzel has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/32251 )
Change subject: Documentation: Allow the use of CSV ......................................................................
Patch Set 1: Code-Review+2
(2 comments)
https://review.coreboot.org/#/c/32251/1/Documentation/getting_started/writin... File Documentation/getting_started/writing_documentation.md:
https://review.coreboot.org/#/c/32251/1/Documentation/getting_started/writin... PS1, Line 105: sphinx Sphinx
https://review.coreboot.org/#/c/32251/1/Documentation/getting_started/writin... PS1, Line 114: markdown Markdown
Patrick Georgi has submitted this change and it was merged. ( https://review.coreboot.org/c/coreboot/+/32251 )
Change subject: Documentation: Allow the use of CSV ......................................................................
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 --- M Documentation/getting_started/writing_documentation.md 1 file changed, 14 insertions(+), 0 deletions(-)
Approvals: build bot (Jenkins): Verified Paul Menzel: Looks good to me, approved
diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md index 4faec18..fb942a4 100644 --- a/Documentation/getting_started/writing_documentation.md +++ b/Documentation/getting_started/writing_documentation.md @@ -100,6 +100,20 @@ 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
-
Patrick Georgi (Code Review) -
Patrick Rudolph (Code Review)
-
Paul Menzel (Code Review)