Change in coreboot[master]: Documentation/writing_documentation.md: Explain how to use docker

[Arthur Heymans (Code Review)]

Arthur Heymans has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/36105 )

Change subject: Documentation/writing_documentation.md: Explain how to use docker
......................................................................

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

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/05/36105/1

diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md
index 15d8765..edca18a 100644
--- a/Documentation/getting_started/writing_documentation.md
+++ b/Documentation/getting_started/writing_documentation.md
@@ -14,7 +14,29 @@
 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

[Patrick Georgi (Code Review)]

Patrick Georgi has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/36105 )

Change subject: Documentation/writing_documentation.md: Explain how to use docker
......................................................................

Patch Set 2: Code-Review+2

[Martin Roth (Code Review)]

Martin Roth has submitted this change. ( https://review.coreboot.org/c/coreboot/+/36105 )

Change subject: Documentation/writing_documentation.md: Explain how to use docker
......................................................................

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 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/36105
Reviewed-by: Patrick Georgi 
Tested-by: build bot (Jenkins) 
---
M Documentation/getting_started/writing_documentation.md
1 file changed, 23 insertions(+), 1 deletion(-)

Approvals:
  build bot (Jenkins): Verified
  Patrick Georgi: Looks good to me, approved

diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md
index 4432e17..dc3cd34 100644
--- a/Documentation/getting_started/writing_documentation.md
+++ b/Documentation/getting_started/writing_documentation.md
@@ -14,7 +14,29 @@
 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