summaryrefslogtreecommitdiff
path: root/Documentation/getting_started
diff options
context:
space:
mode:
authorArthur Heymans <arthur@aheymans.xyz>2018-07-25 12:05:15 +0200
committerPatrick Rudolph <siro@das-labor.org>2018-07-26 11:15:38 +0000
commitc9297c67808dc273d0fad18b452fa9438fa28f5e (patch)
treea491fbf608beeb0d14d388558f120b25cdc2c51d /Documentation/getting_started
parentd308ed37bcc1e8d0bf35752e48a96c144b578dab (diff)
downloadcoreboot-c9297c67808dc273d0fad18b452fa9438fa28f5e.tar.xz
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>
Diffstat (limited to 'Documentation/getting_started')
-rw-r--r--Documentation/getting_started/writing_documentation.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md
index 9a9bbf0c6f..027def96a1 100644
--- a/Documentation/getting_started/writing_documentation.md
+++ b/Documentation/getting_started/writing_documentation.md
@@ -16,7 +16,9 @@ over reStructuredText so only embedded ReST is supported. Checkout the
### Install Sphinx
-Please follow this official [guide].
+Please follow this official [guide] to install sphinx.
+You will also need python-recommonmark for sphinx to be able to handle
+markdown documenation.
### Optional