9203e25a35
Update all pip packages related to coreboot's documentation to their latest available version, and update the doc.coreboot.org base image to Alpine 3.19.1. Add myst-parser in preparation to switch from Recommonmark to MyST Parser. TEST: The documentation builds and renders properly when built using the updated container. Change-Id: I8df4aadabc49c0201a836333745fe138184595ac Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/80312 Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
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