xref: /btstack/doc/manual/Makefile (revision 5b078273c95da8286f191a46c6eb7e72bef41ee2)
1*5b078273SMatthias Ringwaldall: update_content html pdf
2c5d406ecSMatthias Ringwald
3c5d406ecSMatthias Ringwaldhtml:
44f9c2a86SMatthias Ringwald	# docs -> docs_final
51ca3442bSMatthias Ringwald	./markdown2mkdocs.py
6*5b078273SMatthias Ringwald	# generate HTML
71ca3442bSMatthias Ringwald	mkdocs build --clean
8*5b078273SMatthias Ringwald	# post-process HTML
9*5b078273SMatthias Ringwald	./mkdocs2html.py
10c5d406ecSMatthias Ringwald
11c5d406ecSMatthias Ringwaldpdf:
12*5b078273SMatthias Ringwald	rm -rf latex
131ca3442bSMatthias Ringwald	mkdir -p latex
141ca3442bSMatthias Ringwald	cp -r docs/picts latex
154f9c2a86SMatthias Ringwald	# create latex/btstack_generated.md -> latex/btstack_final.tex
164f9c2a86SMatthias Ringwald	./markdown2tex.py
171ca3442bSMatthias Ringwald	cp btstack_gettingstarted.tex latex
1845600c0eSMatthias Ringwald	cp docs/ports/*.jpg latex
191ca3442bSMatthias Ringwald	cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex
201ca3442bSMatthias Ringwald	mv latex/btstack_gettingstarted.pdf btstack.pdf
211ca3442bSMatthias Ringwald
22*5b078273SMatthias Ringwaldpreview: update_content html
23c5d406ecSMatthias Ringwald	# race condition, open browser before startnig MKdocs
24c5d406ecSMatthias Ringwald	open http://127.0.0.1:8000
25c5d406ecSMatthias Ringwald	mkdocs serve
26c5d406ecSMatthias Ringwald
27*5b078273SMatthias Ringwaldupdate_content:
287a656c79SMatthias Ringwald	sed -e "s|../doc/manual/docs/||g" ../../chipset/README.md > docs/chipsets.md
29c5d406ecSMatthias Ringwald	rm -rf tmp
30c5d406ecSMatthias Ringwald	mkdir tmp
314f9c2a86SMatthias Ringwald	# create docs/appendix/apis.md
32c5d406ecSMatthias Ringwald	./update_apis.py
334f9c2a86SMatthias Ringwald	# create docs/examples/examples.md
34c5d406ecSMatthias Ringwald	./update_listings.py
35*5b078273SMatthias Ringwald	# create docs/ports/existing_ports.md
36*5b078273SMatthias Ringwald	./ports2markdown.py
37*5b078273SMatthias Ringwald	# re-create docs_final
38*5b078273SMatthias Ringwald	rm -rf docs_final
39*5b078273SMatthias Ringwald	cp -r docs docs_final
40c5d406ecSMatthias Ringwald
41add0254bSMatthias Ringwaldclean:
42d13e2c60SMatthias Ringwald	rm -rf docs_final tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex
4335e00af0SMatthias Ringwald	rm -rf docs/appendix/apis.md docs/appendix/index.md docs/examples/examples.md docs/chipsets.md
444f9c2a86SMatthias Ringwald	rm -rf latex btstack help
45c1bdcc24SMatthias Ringwald
461ca3442bSMatthias Ringwald
471ca3442bSMatthias Ringwald
48