Commit 8195e21a authored by Vincent Stehlé's avatar Vincent Stehlé
Browse files

Automate documentation generation

We add a Makefile and a configuration file to automate the generation of
README.pdf with pandoc.

Also, update the .gitignore accordingly.

Signed-off-by: Vincent Stehlé's avatarVincent Stehlé <>
parent 8868a128
# Simple makefile to generate the documentation with pandoc.
.PHONY: all doc help clean
all: doc
@echo 'Targets:'
@echo ' all'
@echo ' clean'
@echo ' doc Generate README.pdf'
@echo ' help Print this help.'
doc: README.pdf
%.pdf: pandoc.yaml
pandoc -o$@ $< pandoc.yaml
-rm -f README.pdf
......@@ -30,6 +30,10 @@ you can use the `test_dict` below to see available keys.
* some lines in ekl file follow Different naming Conventions
* some tests in the sequence file are not strongly Associated with the test spec.
### Documentation
It is possible to convert this `` into `README.pdf` with pandoc using
`make doc`. See `make help`.
### TODO:
* double check concatenation of all `.ekl` logs, preliminary tests show small Divergence between them and `summary.ekl` found in `Overall` folder. will generate this file.
toc: true
urlcolor: blue
Supports Markdown
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