summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArthur Heymans <arthur@aheymans.xyz>2019-10-17 22:16:12 +0200
committerMartin Roth <martinroth@google.com>2019-10-27 23:36:07 +0000
commit11b910281e93e648612a7ad8422ee7e30a73e923 (patch)
treecfbd80ff985a7c5580693e5fe19066e07b407b61
parent523ca8d9b0ea59d1e3b106d9d47058a5f8f92d0f (diff)
downloadcoreboot-11b910281e93e648612a7ad8422ee7e30a73e923.tar.xz
Documentation/writing_documentation.md: Explain how to use docker
Using docker to build to documentation eases the process of building the documentation. Given that some versions of sphinx are incompatible, the option to use docker is presented first. Change-Id: I6c18f81a829364ada1859c04ba2dc4f886934bcc Signed-off-by: Arthur Heymans <arthur@aheymans.xyz> Reviewed-on: https://review.coreboot.org/c/coreboot/+/36105 Reviewed-by: Patrick Georgi <pgeorgi@google.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
-rw-r--r--Documentation/getting_started/writing_documentation.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md
index 4432e17afc..dc3cd34413 100644
--- a/Documentation/getting_started/writing_documentation.md
+++ b/Documentation/getting_started/writing_documentation.md
@@ -14,7 +14,29 @@ coreboot uses [Sphinx] documentation tool. We prefer the markdown format
over reStructuredText so only embedded ReST is supported. Checkout the
[Markdown Guide] for more information.
-### Install Sphinx
+### option 1: Use the docker image
+
+The easiest way to build the documentation is using a docker image.
+To build the image run the following in the base directory:
+
+ make -C util/docker/ doc.coreboot.org
+
+Before building the documentation make sure the output directory is given
+the correct permissions before running docker.
+
+ mkdir -p Documentation/_build
+
+To build the documentation:
+
+ make -C util/docker docker-build-docs
+
+To have the documentation build and served over a web server live run:
+
+ make -C util/docker docker-livehtml-docs
+
+On the host machine, open a browser to the address <http://0.0.0.0:8000>.
+
+### option 2: Install Sphinx
Please follow this official [guide] to install sphinx.
You will also need python-recommonmark for sphinx to be able to handle