From 0432c6d56e298e0dd8d77b8ef40c7ad69d3ba912 Mon Sep 17 00:00:00 2001 From: "Brian C. Lane" Date: Thu, 6 Sep 2018 14:08:49 -0700 Subject: [PATCH] Add a Makefile target for building html docs using a rawhide environment This makes it easier to generate new documentation for http://weldr.io/lorax/ It requires having a current welder/lorax-composer:latest image (created with the test-in-docker target), then run docs-in-docker to rerun sphinx with the docs/html directory mounted from the container. --- Makefile | 3 +++ docs/html/README | 5 +++++ 2 files changed, 8 insertions(+) create mode 100644 docs/html/README diff --git a/Makefile b/Makefile index a1a66e79..30ea921a 100644 --- a/Makefile +++ b/Makefile @@ -70,6 +70,9 @@ local: test-in-docker: sudo docker build -t welder/lorax:latest -f Dockerfile.test . +docs-in-docker: + sudo docker run -it --rm -v `pwd`/docs/html/:/lorax/docs/html/ --security-opt label=disable welder/lorax-composer:latest make docs + ci: check test .PHONY: docs diff --git a/docs/html/README b/docs/html/README new file mode 100644 index 00000000..615e8738 --- /dev/null +++ b/docs/html/README @@ -0,0 +1,5 @@ +To build the docs for this branch run: +make test-in-docker +make docs-in-docker + +If you already have a welder/lorax-composer:latest docker image you can skip running 'test-in-docker'.