History

Patrick Georgi a73317e5cf Documentation: enable ditaa integration For prettier diagrams: http://ditaa.sourceforge.net/ Change-Id: Ic28dc5ea9d82ff6bf8654e2e33e675a536348654 Signed-off-by: Patrick Georgi <pgeorgi@google.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/37646 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net> Reviewed-by: Angel Pons <th3fanbus@gmail.com>		2019-12-12 08:18:49 +00:00
..
Dockerfile	Documentation: enable ditaa integration	2019-12-12 08:18:49 +00:00
README.md	util/docker/doc.coreboot.org/Dockerfile: Use alpine:3.8, Sphinx 1.7	2018-08-23 15:56:31 +00:00
ditaa.sh	Documentation: enable ditaa integration	2019-12-12 08:18:49 +00:00
makeSphinx.sh	util/docker/doc.coreboot.org/Dockerfile: Use alpine:3.8, Sphinx 1.7	2018-08-23 15:56:31 +00:00

README.md

doc.coreboot.org

Docker container for generating and developing documentation for doc.coreboot.org

NOTE: All paths are from the base of the coreboot git repo.

Build

  docker build --force-rm -t "doc.coreboot.org" "$PWD/util/docker/doc.coreboot.org/"

Generating production HTML

# To ensure the output directory is given the correct permissions, make sure to
# created it before running docker the first time.
mkdir -p "$PWD/Documentation/_build/"

docker run -it --rm \
           --user "$(id -u):$(id -g)" \
           -v "$PWD/:/data-in/:ro" \
           -v "$PWD/Documentation/_build/:/data-out/" \
           doc.coreboot.org

live reloaded with web server

On the host machine, open a browser to the address http://0.0.0.0:8000

docker run -it --rm \
           --net=host -v "$PWD/:/data-in/:ro" \
           doc.coreboot.org livehtml