xref: /btstack/doc/manual/Makefile (revision 4f9c2a860130fe88bc96e212e516377b0a640c2d)
1*4f9c2a86SMatthias Ringwaldall: update_apis_and_listings html pdf
2c5d406ecSMatthias Ringwald
3c5d406ecSMatthias Ringwaldhtml:
41ca3442bSMatthias Ringwald	rm -rf docs_final
51ca3442bSMatthias Ringwald	cp -r docs docs_final
6*4f9c2a86SMatthias Ringwald	# create docs/ports/existing_ports.md
741026ca6SMilanka Ringwald	./ports2markdown.py
8*4f9c2a86SMatthias Ringwald	# docs -> docs_final
91ca3442bSMatthias Ringwald	./markdown2mkdocs.py
101ca3442bSMatthias Ringwald	mkdocs build --clean
111ca3442bSMatthias Ringwald	./mkdocs2html.py
12c5d406ecSMatthias Ringwald
13c5d406ecSMatthias Ringwaldpdf:
141ca3442bSMatthias Ringwald	mkdir -p latex
151ca3442bSMatthias Ringwald	cp -r docs/picts latex
16*4f9c2a86SMatthias Ringwald	# create docs/ports/existing_ports.md
1741026ca6SMilanka Ringwald	./ports2markdown.py
18*4f9c2a86SMatthias Ringwald	# create latex/btstack_generated.md -> latex/btstack_final.tex
19*4f9c2a86SMatthias Ringwald	./markdown2tex.py
201ca3442bSMatthias Ringwald	cp btstack_gettingstarted.tex latex
211ca3442bSMatthias Ringwald	cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex
221ca3442bSMatthias Ringwald	mv latex/btstack_gettingstarted.pdf btstack.pdf
231ca3442bSMatthias Ringwald	rm -rf latex tmp
241ca3442bSMatthias Ringwald
25c5d406ecSMatthias Ringwald
26*4f9c2a86SMatthias Ringwaldpreview: update_apis_and_listings html
27c5d406ecSMatthias Ringwald	# race condition, open browser before startnig MKdocs
28c5d406ecSMatthias Ringwald	open http://127.0.0.1:8000
29c5d406ecSMatthias Ringwald	mkdocs serve
30c5d406ecSMatthias Ringwald
31*4f9c2a86SMatthias Ringwaldupdate_apis_and_listings:
327a656c79SMatthias Ringwald	sed -e "s|../doc/manual/docs/||g" ../../chipset/README.md > docs/chipsets.md
33c5d406ecSMatthias Ringwald	rm -rf tmp
34c5d406ecSMatthias Ringwald	mkdir tmp
35*4f9c2a86SMatthias Ringwald	# create docs/appendix/apis.md
36c5d406ecSMatthias Ringwald	./update_apis.py
37*4f9c2a86SMatthias Ringwald	# create docs/examples/examples.md
38c5d406ecSMatthias Ringwald	./update_listings.py
39c5d406ecSMatthias Ringwald
40add0254bSMatthias Ringwaldclean:
41d13e2c60SMatthias Ringwald	rm -rf docs_final tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex
4235e00af0SMatthias Ringwald	rm -rf docs/appendix/apis.md docs/appendix/index.md docs/examples/examples.md docs/chipsets.md
43*4f9c2a86SMatthias Ringwald	rm -rf latex btstack help
44c1bdcc24SMatthias Ringwald
451ca3442bSMatthias Ringwald
461ca3442bSMatthias Ringwald
47