xref: /btstack/doc/manual/Makefile (revision 767003cd115da71832c8007cf328154b1a0c8dfd)
15b078273SMatthias Ringwaldall: update_content html pdf
2c5d406ecSMatthias Ringwald
3c5d406ecSMatthias Ringwaldhtml:
44f9c2a86SMatthias Ringwald	# docs -> docs_final
51ca3442bSMatthias Ringwald	./markdown2mkdocs.py
65b078273SMatthias Ringwald	# generate HTML
71ca3442bSMatthias Ringwald	mkdocs build --clean
85b078273SMatthias Ringwald	# post-process HTML
95b078273SMatthias Ringwald	./mkdocs2html.py
10c5d406ecSMatthias Ringwald
11c5d406ecSMatthias Ringwaldpdf:
125b078273SMatthias Ringwald	rm -rf latex
131ca3442bSMatthias Ringwald	mkdir -p latex
141ca3442bSMatthias Ringwald	cp -r docs/picts latex
15*767003cdSMatthias Ringwald	# create latex/btstack_gettingstartec.tex with version
16*767003cdSMatthias Ringwald	./update_getting_started.sh
174f9c2a86SMatthias Ringwald	# create latex/btstack_generated.md -> latex/btstack_final.tex
184f9c2a86SMatthias Ringwald	./markdown2tex.py
1945600c0eSMatthias Ringwald	cp docs/ports/*.jpg latex
201ca3442bSMatthias Ringwald	cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex
211ca3442bSMatthias Ringwald	mv latex/btstack_gettingstarted.pdf btstack.pdf
221ca3442bSMatthias Ringwald
235b078273SMatthias Ringwaldpreview: update_content html
24d5a53792SMatthias Ringwald	# race condition, open browser before starting MKdocs server
25c5d406ecSMatthias Ringwald	open http://127.0.0.1:8000
26c5d406ecSMatthias Ringwald	mkdocs serve
27c5d406ecSMatthias Ringwald
285b078273SMatthias Ringwaldupdate_content:
297a656c79SMatthias Ringwald	sed -e "s|../doc/manual/docs/||g" ../../chipset/README.md > docs/chipsets.md
30c5d406ecSMatthias Ringwald	rm -rf tmp
31c5d406ecSMatthias Ringwald	mkdir tmp
32d5a53792SMatthias Ringwald	# create mkdocs.yml
33d5a53792SMatthias Ringwald	./update_mkdocs_yml.sh
344f9c2a86SMatthias Ringwald	# create docs/appendix/apis.md
35c5d406ecSMatthias Ringwald	./update_apis.py
364f9c2a86SMatthias Ringwald	# create docs/examples/examples.md
37c5d406ecSMatthias Ringwald	./update_listings.py
385b078273SMatthias Ringwald	# create docs/ports/existing_ports.md
395b078273SMatthias Ringwald	./ports2markdown.py
401ea30d1bSMilanka Ringwald	# create docs/gatt_clients.md and  docs/gatt_services.md
411ea30d1bSMilanka Ringwald	./update_gatt_services.py
425b078273SMatthias Ringwald	# re-create docs_final
435b078273SMatthias Ringwald	rm -rf docs_final
445b078273SMatthias Ringwald	cp -r docs docs_final
45c5d406ecSMatthias Ringwald
46add0254bSMatthias Ringwaldclean:
47a999813fSMatthias Ringwald	rm -rf docs_final tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex mkdocs.yml
481ea30d1bSMilanka Ringwald	rm -rf docs/appendix/apis.md api_index.md docs/examples/examples.md docs/chipsets.md
491ea30d1bSMilanka Ringwald	rm -rf docs/gatt_clients.md docs/gatt_services.md
504f9c2a86SMatthias Ringwald	rm -rf latex btstack help
51c1bdcc24SMatthias Ringwald
521ca3442bSMatthias Ringwald
531ca3442bSMatthias Ringwald
54