From c9297c67808dc273d0fad18b452fa9438fa28f5e Mon Sep 17 00:00:00 2001 From: Arthur Heymans Date: Wed, 25 Jul 2018 12:05:15 +0200 Subject: 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 Reviewed-on: https://review.coreboot.org/27631 Tested-by: build bot (Jenkins) Reviewed-by: Philipp Deppenwiese --- Documentation/getting_started/writing_documentation.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'Documentation/getting_started/writing_documentation.md') 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 -- cgit v1.2.3