xref: /btstack/doc/manual/Makefile (revision 41d889f346c8c7033115b3f0769b8cf1743fd415)
1all: update_content html pdf
2
3html:
4	# docs -> docs_final
5	./markdown2mkdocs.py
6	# generate HTML
7	mkdocs build --clean
8	# post-process HTML
9	./mkdocs2html.py
10
11pdf:
12	rm -rf latex
13	mkdir -p latex
14	cp -r docs/picts latex
15	# create latex/btstack_gettingstartec.tex with version
16	./update_getting_started.sh
17	# create latex/btstack_generated.md -> latex/btstack_final.tex
18	./markdown2tex.py
19	cp docs/ports/*.jpg latex
20	cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex
21	mv latex/btstack_gettingstarted.pdf btstack.pdf
22
23preview: update_content html
24	# race condition, open browser before starting MKdocs server
25	open http://127.0.0.1:8010
26	mkdocs serve -a localhost:8010
27
28update_content:
29	sed -e "s|../doc/manual/docs-template/||g" ../../chipset/README.md > docs-template/chipsets.md
30	rm -rf tmp
31	mkdir tmp
32	# create mkdocs.yml
33	./update_mkdocs_yml.sh
34	# create docs-template/appendix/apis.md
35	./update_apis.py
36	# create docs-template/examples/examples.md
37	./update_listings.py
38	# create docs-template/ports/existing_ports.md
39	./ports2markdown.py
40	# create docs-template/gatt_clients.md and  docs-template/gatt_services.md
41	./update_gatt_services.py
42	# re-create docs_final
43	rm -rf docs
44	cp -r docs-template docs
45
46clean:
47	rm -rf docs tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex mkdocs.yml
48	rm -rf docs-template/appendix/apis.md docs-template/examples/examples.md docs-template/chipsets.md
49	rm -rf docs-template/gatt_clients.md docs-template/gatt_services.md
50	rm -rf api_index.md
51	rm -rf latex btstack help
52
53
54
55