Felix Held has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/37952 )
Change subject: Documentation: document non-Docker sphinx installation and usage ......................................................................
Documentation: document non-Docker sphinx installation and usage
Change-Id: I0f63860beb0a8a00360752318236e302c7170977 Signed-off-by: Felix Held felix-coreboot@felixheld.de --- M Documentation/getting_started/writing_documentation.md 1 file changed, 16 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/52/37952/1
diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md index dc3cd34..51c248f 100644 --- a/Documentation/getting_started/writing_documentation.md +++ b/Documentation/getting_started/writing_documentation.md @@ -45,6 +45,22 @@ 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 + +Now cd into the Documentation folder and run + + make sphinx + +If no error occurs, you can find the generated HTML documentation in +Documentation/_build now. + ### Optional
Install [sphinx-autobuild] for rebuilding markdown/rst sources on the fly!