[coreboot-gerrit] Change in coreboot[master]: Documentation/writing_docs: Document the need for recommonmark

Patrick Rudolph (Code Review) gerrit at coreboot.org
Thu Jul 26 13:15:42 CEST 2018


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 at aheymans.xyz>
Reviewed-on: https://review.coreboot.org/27631
Tested-by: build bot (Jenkins) <no-reply at coreboot.org>
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki at 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
 

-- 
To view, visit https://review.coreboot.org/27631
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings

Gerrit-Project: coreboot
Gerrit-Branch: master
Gerrit-MessageType: merged
Gerrit-Change-Id: I9513ab4bdc753e0350754d9869239ea833893af9
Gerrit-Change-Number: 27631
Gerrit-PatchSet: 3
Gerrit-Owner: Arthur Heymans <arthur at aheymans.xyz>
Gerrit-Reviewer: Patrick Rudolph <siro at das-labor.org>
Gerrit-Reviewer: Philipp Deppenwiese <zaolin.daisuki at gmail.com>
Gerrit-Reviewer: build bot (Jenkins) <no-reply at coreboot.org>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.coreboot.org/pipermail/coreboot-gerrit/attachments/20180726/598090b0/attachment.html>


More information about the coreboot-gerrit mailing list