util/docker/Makefile: Add documentation docker image targets
Run - make -C util/docker doc.coreboot.org to build the docker image - make -C util/docker docker-build-docs to build the documentation - make -C docker-livehtml-docs to serve autoupdated documentation over http://0.0.0.0:8000 Change-Id: Ic07f216f8d90d6e212383250b852dc91575304c3 Signed-off-by: Arthur Heymans <arthur@aheymans.xyz> Reviewed-on: https://review.coreboot.org/c/coreboot/+/36104 Reviewed-by: Patrick Georgi <pgeorgi@google.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
This commit is contained in:
parent
44b54aa947
commit
593172c7c3
|
@ -71,6 +71,10 @@ coreboot-jenkins-node: test-docker
|
||||||
upload-coreboot-jenkins-node: test-docker-login
|
upload-coreboot-jenkins-node: test-docker-login
|
||||||
$(DOCKER) push coreboot/coreboot-jenkins-node:$(COREBOOT_IMAGE_TAG)
|
$(DOCKER) push coreboot/coreboot-jenkins-node:$(COREBOOT_IMAGE_TAG)
|
||||||
|
|
||||||
|
doc.coreboot.org: test-docker
|
||||||
|
$(DOCKER) build --force-rm -t doc.coreboot.org \
|
||||||
|
$(top)/util/docker/doc.coreboot.org/
|
||||||
|
|
||||||
docker-killall: test-docker
|
docker-killall: test-docker
|
||||||
@if [ -n "$$($(DOCKER) ps | grep 'coreboot')" ]; then \
|
@if [ -n "$$($(DOCKER) ps | grep 'coreboot')" ]; then \
|
||||||
$(DOCKER) kill $$($(DOCKER) ps | grep 'coreboot' | cut -f1 -d ' '); \
|
$(DOCKER) kill $$($(DOCKER) ps | grep 'coreboot' | cut -f1 -d ' '); \
|
||||||
|
@ -166,12 +170,27 @@ docker-jenkins-attach:
|
||||||
-it "$$(docker ps | grep coreboot-jenkins-node | cut -f1 -d' ')" \
|
-it "$$(docker ps | grep coreboot-jenkins-node | cut -f1 -d' ')" \
|
||||||
/bin/bash -l
|
/bin/bash -l
|
||||||
|
|
||||||
|
docker-build-docs: test-docker
|
||||||
|
docker-build-docs:
|
||||||
|
$(DOCKER) run -it --rm \
|
||||||
|
--user $(UID):$(GID) \
|
||||||
|
-v "$(top)/:/data-in/:ro" \
|
||||||
|
-v "$(top)/Documentation/_build/:/data-out/" \
|
||||||
|
doc.coreboot.org
|
||||||
|
|
||||||
|
docker-livehtml-docs: test-docker
|
||||||
|
docker-livehtml-docs:
|
||||||
|
$(DOCKER) run -it --rm \
|
||||||
|
--net=host -v "$(top)/:/data-in/:ro" \
|
||||||
|
doc.coreboot.org livehtml
|
||||||
|
|
||||||
help:
|
help:
|
||||||
@echo "Commands for working with docker images:"
|
@echo "Commands for working with docker images:"
|
||||||
@echo " coreboot-sdk - Build coreboot-sdk container"
|
@echo " coreboot-sdk - Build coreboot-sdk container"
|
||||||
@echo " upload-coreboot-sdk - Upload coreboot-sdk to hub.docker.com"
|
@echo " upload-coreboot-sdk - Upload coreboot-sdk to hub.docker.com"
|
||||||
@echo " coreboot-jenkins-node - Build coreboot-jenkins-node container"
|
@echo " coreboot-jenkins-node - Build coreboot-jenkins-node container"
|
||||||
@echo " upload-coreboot-jenkins-node - Upload coreboot-jenkins-node to hub.docker.com"
|
@echo " upload-coreboot-jenkins-node - Upload coreboot-jenkins-node to hub.docker.com"
|
||||||
|
@echo " doc.coreboot.org - Build doc.coreboot.org container"
|
||||||
@echo " clean-coreboot-containers - Remove all docker coreboot containers"
|
@echo " clean-coreboot-containers - Remove all docker coreboot containers"
|
||||||
@echo " clean-coreboot-images - Remove all docker coreboot images"
|
@echo " clean-coreboot-images - Remove all docker coreboot images"
|
||||||
@echo " clean-docker - Remove docker coreboot containers & images"
|
@echo " clean-docker - Remove docker coreboot containers & images"
|
||||||
|
@ -186,6 +205,8 @@ help:
|
||||||
@echo " <USER=root or USER=coreboot>"
|
@echo " <USER=root or USER=coreboot>"
|
||||||
@echo " docker-jenkins-server - Run coreboot-jenkins-node image (for server)"
|
@echo " docker-jenkins-server - Run coreboot-jenkins-node image (for server)"
|
||||||
@echo " docker-jenkins-attach - Open shell in running jenkins server"
|
@echo " docker-jenkins-attach - Open shell in running jenkins server"
|
||||||
|
@echo " docker-build-docs - Build the documentation"
|
||||||
|
@echo " docker-livehtml-docs - Run sphinx-autobuild"
|
||||||
@echo
|
@echo
|
||||||
@echo "Variables:"
|
@echo "Variables:"
|
||||||
@echo " COREBOOT_JENKINS_PORT=$(COREBOOT_JENKINS_PORT)"
|
@echo " COREBOOT_JENKINS_PORT=$(COREBOOT_JENKINS_PORT)"
|
||||||
|
@ -197,7 +218,9 @@ help:
|
||||||
.PHONY: test-docker test-docker-login
|
.PHONY: test-docker test-docker-login
|
||||||
.PHONY: coreboot-jenkins-node upload-coreboot-jenkins-node
|
.PHONY: coreboot-jenkins-node upload-coreboot-jenkins-node
|
||||||
.PHONY: coreboot-sdk upload-coreboot-sdk
|
.PHONY: coreboot-sdk upload-coreboot-sdk
|
||||||
|
.PHONY: doc.coreboot.org
|
||||||
.PHONY: clean-coreboot-containers clean-coreboot-images
|
.PHONY: clean-coreboot-containers clean-coreboot-images
|
||||||
.PHONY: docker-abuild
|
.PHONY: docker-abuild
|
||||||
.PHONY: docker-what-jenkins-does docker-shell docker-jenkins-server docker-jenkins-attach
|
.PHONY: docker-what-jenkins-does docker-shell docker-jenkins-server docker-jenkins-attach
|
||||||
|
.PHONY: docker-build-docs docker-livehtml-docs
|
||||||
.PHONY: help
|
.PHONY: help
|
||||||
|
|
Loading…
Reference in New Issue