Patrick Georgi submitted this change.

View Change

Documentation: document non-Docker sphinx installation and usage

Also update the known-good versions of the needed tools.

Change-Id: I0f63860beb0a8a00360752318236e302c7170977
Signed-off-by: Felix Held <felix-coreboot@felixheld.de>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/37952
Reviewed-by: Patrick Rudolph <siro@das-labor.org>
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
---
M Documentation/getting_started/writing_documentation.md
1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md
index dc3cd34..384fc6d 100644
--- a/Documentation/getting_started/writing_documentation.md
+++ b/Documentation/getting_started/writing_documentation.md
@@ -42,8 +42,25 @@
 You will also need python-recommonmark for sphinx to be able to handle
 markdown documentation.
 
-The recommended version is sphinx 1.7.7, sphinx_rtd_theme 0.4.1 and
-recommonmark 0.4.0.
+Since some Linux distributions don't package every needed sphinx extension,
+the installation via pip in a venv is recommended. You'll need these python3
+modules:
+
+* sphinx
+* recommonmark
+* sphinx_rtd_theme
+* sphinxcontrib-ditaa
+
+The following combination of versions has been tested: sphinx 2.3.1,
+recommonmark 0.6.0, sphinx_rtd_theme 0.4.3 and sphinxcontrib-ditaa 0.7.
+
+Now change into the `Documentation` folder in the coreboot directory and run
+this command in there
+
+	make sphinx
+
+If no error occurs, you can find the generated HTML documentation in
+`Documentation/_build` now.
 
 ### Optional
 

To view, visit change 37952. To unsubscribe, or for help writing mail filters, visit settings.