Patrick Rudolph has submitted this change and it was merged. ( https://review.coreboot.org/27631 )
Change subject: Documentation/writing_docs: Document the need for recommonmark ......................................................................
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 --- M Documentation/getting_started/writing_documentation.md 1 file changed, 3 insertions(+), 1 deletion(-)
Approvals: build bot (Jenkins): Verified Philipp Deppenwiese: Looks good to me, approved
diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md index 9a9bbf0..027def9 100644 --- a/Documentation/getting_started/writing_documentation.md +++ b/Documentation/getting_started/writing_documentation.md @@ -16,7 +16,9 @@
### 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