xref: /btstack/doc/manual/Makefile (revision d5a537929982b7ad27eb9fe0a2bf3b3feea42977)
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
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
225b078273SMatthias Ringwaldpreview: update_content html
23*d5a53792SMatthias Ringwald	# race condition, open browser before starting MKdocs server
24c5d406ecSMatthias Ringwald	open http://127.0.0.1:8000
25c5d406ecSMatthias Ringwald	mkdocs serve
26c5d406ecSMatthias Ringwald
275b078273SMatthias 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
31*d5a53792SMatthias Ringwald	# create mkdocs.yml
32*d5a53792SMatthias Ringwald	./update_mkdocs_yml.sh
334f9c2a86SMatthias Ringwald	# create docs/appendix/apis.md
34c5d406ecSMatthias Ringwald	./update_apis.py
354f9c2a86SMatthias Ringwald	# create docs/examples/examples.md
36c5d406ecSMatthias Ringwald	./update_listings.py
375b078273SMatthias Ringwald	# create docs/ports/existing_ports.md
385b078273SMatthias Ringwald	./ports2markdown.py
395b078273SMatthias Ringwald	# re-create docs_final
405b078273SMatthias Ringwald	rm -rf docs_final
415b078273SMatthias Ringwald	cp -r docs docs_final
42c5d406ecSMatthias Ringwald
43add0254bSMatthias Ringwaldclean:
44d13e2c60SMatthias Ringwald	rm -rf docs_final tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex
4535e00af0SMatthias Ringwald	rm -rf docs/appendix/apis.md docs/appendix/index.md docs/examples/examples.md docs/chipsets.md
464f9c2a86SMatthias Ringwald	rm -rf latex btstack help
47c1bdcc24SMatthias Ringwald
481ca3442bSMatthias Ringwald
491ca3442bSMatthias Ringwald
50