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

Arthur Heymans (Code Review) gerrit at coreboot.org
Wed Jul 25 12:07:29 CEST 2018


Arthur Heymans has uploaded this change for review. ( https://review.coreboot.org/27631


Change subject: Documentation/writing_docs: Also document the need for recommonmark
......................................................................

Documentation/writing_docs: Also 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>
---
M Documentation/getting_started/writing_documentation.md
1 file changed, 3 insertions(+), 1 deletion(-)



  git pull ssh://review.coreboot.org:29418/coreboot refs/changes/31/27631/1

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: newchange
Gerrit-Change-Id: I9513ab4bdc753e0350754d9869239ea833893af9
Gerrit-Change-Number: 27631
Gerrit-PatchSet: 1
Gerrit-Owner: Arthur Heymans <arthur at aheymans.xyz>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.coreboot.org/pipermail/coreboot-gerrit/attachments/20180725/3df12b01/attachment.html>


More information about the coreboot-gerrit mailing list