forked from opencontainers/runtime-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
I do not like having this build step of printable documentation depending on pulling a container, but the pandoc+latex combo is a big bundle. This is the minimal and cleanest approach for using these tools, for now. Signed-off-by: Vincent Batts <[email protected]>
- Loading branch information
Showing
1 changed file
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
|
||
DOCKER ?= $(shell which docker) | ||
DOC_FILES := \ | ||
README.md \ | ||
code-of-conduct.md \ | ||
principles.md \ | ||
ROADMAP.md \ | ||
implementations.md \ | ||
bundle.md \ | ||
runtime.md \ | ||
runtime-linux.md \ | ||
config.md \ | ||
config-linux.md \ | ||
runtime-config.md \ | ||
runtime-config-linux.md | ||
|
||
docs: pdf html | ||
|
||
pdf: | ||
@mkdir -p output/ && \ | ||
$(DOCKER) run \ | ||
-it \ | ||
--rm \ | ||
-v $(shell pwd)/:/input/:ro \ | ||
-v $(shell pwd)/output/:/output/ \ | ||
-u $(shell id -u) \ | ||
vbatts/pandoc -f markdown_github -t latex -o /output/docs.pdf $(patsubst %,/input/%,$(DOC_FILES)) && \ | ||
ls -sh $(shell readlink -f output/docs.pdf) | ||
|
||
html: | ||
@mkdir -p output/ && \ | ||
$(DOCKER) run \ | ||
-it \ | ||
--rm \ | ||
-v $(shell pwd)/:/input/:ro \ | ||
-v $(shell pwd)/output/:/output/ \ | ||
-u $(shell id -u) \ | ||
vbatts/pandoc -f markdown_github -t html5 -o /output/docs.html $(patsubst %,/input/%,$(DOC_FILES)) && \ | ||
ls -sh $(shell readlink -f output/docs.html) | ||
|
||
clean: | ||
rm -rf output/ *~ | ||
|