Patrick Rudolph
1e742217e6
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 >
2019-04-11 11:21:05 +00:00
Philipp Bartsch
654d7b5e0b
Documentation: Fix broken link
...
Change-Id: Idd08bc49fb7bf3770e03f747d97d90aacc12eada
Signed-off-by: Philipp Bartsch <phil@grmr.de >
Reviewed-on: https://review.coreboot.org/c/coreboot/+/32145
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
Reviewed-by: Patrick Rudolph <siro@das-labor.org >
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net >
2019-04-04 10:35:24 +00:00
Patrick Rudolph
3d1d966dd8
Documentation: Describe recommonmark's auto_toc_tree
...
Explain recommonmark's auto_toc_tree and give an example to make writing
documentation easier. Show an example what happens if the document
isn't included in any toctree.
Change-Id: I4938d8d292ea890caec6d396b4fa04da65e398f4
Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com >
Reviewed-on: https://review.coreboot.org/28427
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
Reviewed-by: Tom Hiller <thrilleratplay@gmail.com >
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com >
2018-09-30 03:18:25 +00:00
Tom Hiller
ffe6d54151
Documentation: Disable auto_doc_ref
...
According to recommonmark's documentation the enable_auto_doc_ref is deprecated.
This is not true, as it's broken with Sphinx 1.6+ commit
12d639873953847de31ec99742b42e50e89ed58c.
recommonmark bug report is here: https://github.com/rtfd/recommonmark/issues/73
Instead of using this feature, which doesn't support top level directories in
the relative document path anyway, use the TOC tree or inline RST code.
Disable auto_doc_ref and document how to reference documents.
Change-Id: I9319985b504c4215c33ebbeb9c38317b9efcb283
Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com >
Reviewed-on: https://review.coreboot.org/28550
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
Reviewed-by: Tom Hiller <thrilleratplay@gmail.com >
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com >
2018-09-30 03:18:05 +00:00
Arthur Heymans
c9297c6780
Documentation/writing_docs: Document the need for recommonmark
...
python-recommonmark is need for sphinx to be able to hande the markdown
documentation.
Change-Id: I9513ab4bdc753e0350754d9869239ea833893af9
Signed-off-by: Arthur Heymans <arthur@aheymans.xyz >
Reviewed-on: https://review.coreboot.org/27631
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com >
2018-07-26 11:15:38 +00:00
Patrick Rudolph
7a2a29d0e1
Documentation: Add rules for writing Documentation
...
Change-Id: Ic3808a0a10ddc8064d185e0920dcd9f60c435419
Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com >
Reviewed-on: https://review.coreboot.org/26602
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
Reviewed-by: Martin Roth <martinroth@google.com >
2018-06-13 17:43:20 +00:00
