mirror of
https://review.coreboot.org/flashrom.git
synced 2025-04-26 22:52:34 +02:00
f5a3c7a35b
- Update the base system (alpine 3.8 -> 3.21) - Update sphinx and its modules (and from pip-install to alpine-install) - Remove unused features that increase maintenance overhead (autobuild/livehtml and ditaa) - Use the build system to generate docs (instead of calling sphinx in its own, custom ways) Change-Id: I844e4ea84b94444c96f29325fee205b0deb972da Signed-off-by: Patrick Georgi <patrick@georgi-clan.de> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86681 Reviewed-by: Anastasia Klimchuk <aklm@chromium.org> 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.flashrom.org" "$PWD/util/docker/flashrom.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/doc/_build/"
docker run -it --rm \
--user "$(id -u):$(id -g)" \
-v "$PWD/:/data-in/:ro" \
-v "$PWD/doc/_build/:/data-out/" \
doc.flashrom.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.flashrom.org livehtml