xref: /btstack/doc/manual/Makefile (revision 45600c0eb7e2656f78aafe98e5cc7f8bbecc4f36)
14f9c2a86SMatthias Ringwaldall: update_apis_and_listings html pdf
2c5d406ecSMatthias Ringwald
3c5d406ecSMatthias Ringwaldhtml:
4b52cd3d3SMatthias Ringwald	# create docs/ports/existing_ports.md + adds images
5b52cd3d3SMatthias Ringwald	./ports2markdown.py
6b52cd3d3SMatthias Ringwald	# re-create docs_final
71ca3442bSMatthias Ringwald	rm -rf docs_final
81ca3442bSMatthias Ringwald	cp -r docs docs_final
94f9c2a86SMatthias Ringwald	# docs -> docs_final
101ca3442bSMatthias Ringwald	./markdown2mkdocs.py
111ca3442bSMatthias Ringwald	mkdocs build --clean
121ca3442bSMatthias Ringwald	./mkdocs2html.py
13c5d406ecSMatthias Ringwald
14c5d406ecSMatthias Ringwaldpdf:
151ca3442bSMatthias Ringwald	mkdir -p latex
161ca3442bSMatthias Ringwald	cp -r docs/picts latex
174f9c2a86SMatthias Ringwald	# create docs/ports/existing_ports.md
1841026ca6SMilanka Ringwald	./ports2markdown.py
194f9c2a86SMatthias Ringwald	# create latex/btstack_generated.md -> latex/btstack_final.tex
204f9c2a86SMatthias Ringwald	./markdown2tex.py
211ca3442bSMatthias Ringwald	cp btstack_gettingstarted.tex latex
22*45600c0eSMatthias Ringwald	cp docs/ports/*.jpg latex
231ca3442bSMatthias Ringwald	cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex
241ca3442bSMatthias Ringwald	mv latex/btstack_gettingstarted.pdf btstack.pdf
251ca3442bSMatthias Ringwald	rm -rf latex tmp
261ca3442bSMatthias Ringwald
27c5d406ecSMatthias Ringwald
284f9c2a86SMatthias Ringwaldpreview: update_apis_and_listings html
29c5d406ecSMatthias Ringwald	# race condition, open browser before startnig MKdocs
30c5d406ecSMatthias Ringwald	open http://127.0.0.1:8000
31c5d406ecSMatthias Ringwald	mkdocs serve
32c5d406ecSMatthias Ringwald
334f9c2a86SMatthias Ringwaldupdate_apis_and_listings:
347a656c79SMatthias Ringwald	sed -e "s|../doc/manual/docs/||g" ../../chipset/README.md > docs/chipsets.md
35c5d406ecSMatthias Ringwald	rm -rf tmp
36c5d406ecSMatthias Ringwald	mkdir tmp
374f9c2a86SMatthias Ringwald	# create docs/appendix/apis.md
38c5d406ecSMatthias Ringwald	./update_apis.py
394f9c2a86SMatthias Ringwald	# create docs/examples/examples.md
40c5d406ecSMatthias Ringwald	./update_listings.py
41c5d406ecSMatthias Ringwald
42add0254bSMatthias Ringwaldclean:
43d13e2c60SMatthias Ringwald	rm -rf docs_final tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex
4435e00af0SMatthias Ringwald	rm -rf docs/appendix/apis.md docs/appendix/index.md docs/examples/examples.md docs/chipsets.md
454f9c2a86SMatthias Ringwald	rm -rf latex btstack help
46c1bdcc24SMatthias Ringwald
471ca3442bSMatthias Ringwald
481ca3442bSMatthias Ringwald
49