Commit a800a95a authored by Vincent Stehlé's avatar Vincent Stehlé
Browse files

Add a make check target

This runs yamllint for the moment, but can be extended to do more in the
Signed-off-by: Vincent Stehlé's avatarVincent Stehlé <>
parent f153e735
# Simple makefile to generate the documentation with pandoc.
.PHONY: all doc help clean
.PHONY: all doc help clean check
all: doc
@echo 'Targets:'
@echo ' all'
@echo ' check Perform sanity checks (currently yamllint)'
@echo ' clean'
@echo ' doc Generate README.pdf'
@echo ' help Print this help.'
......@@ -15,5 +16,8 @@ doc: README.pdf
%.pdf: pandoc.yaml
pandoc -o$@ $< pandoc.yaml
yamllint .
-rm -f README.pdf
......@@ -210,6 +210,11 @@ This generated configuration can then be further edited manually.
It is possible to convert this `` into `README.pdf` with pandoc using
`make doc`. See `make help`.
### Sanity checks
To perform sanity checks, run `make check`. For the moment this runs `yamllint`,
which will inspect all YAML files and report errors. See `make help`.
### db structure:
``` {.python}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment