History

Martin Roth 0ad5fbd48d util: Update all shebangs to use /usr/bin/env Instead of hardcoding paths to the executables, use the version in the path. This allows the scripts to work on more systems, and allows the binary version to be changed more easily if needed. Signed-off-by: Martin Roth <martin@coreboot.org> Change-Id: Ifcc56aa21092cd3866eacb6a02d198110ec6051d Reviewed-on: https://review.coreboot.org/c/coreboot/+/48904 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Angel Pons <th3fanbus@gmail.com>		2021-01-25 08:57:40 +00:00
..
Dockerfile	Documentation: enable ditaa integration	2019-12-12 08:18:49 +00:00
README.md	…
ditaa.sh	util: Update all shebangs to use /usr/bin/env	2021-01-25 08:57:40 +00:00
makeSphinx.sh	util: Update all shebangs to use /usr/bin/env	2021-01-25 08:57:40 +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