openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-08-17 12:20:15 +02:00
Code Issues Releases Wiki Activity

util: Add docker to automate creation of documentation

Browse Source 
Build with:
 docker build --force-rm -t "doc.flashrom.org" \
	      "$PWD/util/docker/flashrom.org/"

Generate HTML files:
 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 web server:
 docker run -it --rm \
            --net=host -v "$PWD/:/data-in/:ro" \
            doc.flashrom.org livehtml

Change-Id: I889fa5f98e2fd6ef896ba4bb30aa5d985ff82622
Signed-off-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Tested-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/75344
Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
Tested-by: Anastasia Klimchuk <aklm@chromium.org>
This commit is contained in:
Stefan Reinauer
2023-05-19 22:44:42 -07:00
committed by Anastasia Klimchuk
parent f15e6a105b
commit 5c8469953b
4 changed files with 75 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
util/docker/flashrom.org/makeSphinx.sh Executable file
View File

@@ -0,0 +1,12 @@
#!/usr/bin/env bash
if [ "$1" == "livehtml" ]; then
echo "Starting live documentation build"
cd /data-in/ && sphinx-autobuild -b html doc /tmp/build/html
else
echo "Starting production documentation build"
cd /data-in/ \
&& sphinx-build -b html doc /tmp/build/html \
&& rm -rf /data-out/* \
&& mv /tmp/build/html/* /data-out/
fi