almalinux/lorax
13
0
Fork 0
Code Issues Pull Requests Releases Activity

Add a Makefile target for building html docs using a rawhide environment

Browse Source 
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.
This commit is contained in:
Brian C. Lane 2018-09-06 14:08:49 -07:00
parent 45e093241d
commit 0432c6d56e
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile
View File

@ -70,6 +70,9 @@ local:
test-in-docker: test-in-docker:
sudo docker build -t welder/lorax:latest -f Dockerfile.test . 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 ci: check test
.PHONY: docs .PHONY: docs

5
docs/html/README Normal file
View File

@ -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'.