1503a627eSMilanka RingwaldGITHUB_URL = "https://github.com/bluekitchen/btstack/tree/" 2503a627eSMilanka RingwaldBTSTACK_FOLDER = ../../ 3503a627eSMilanka RingwaldINTRO_FOLDER = docs-intro/ 4503a627eSMilanka RingwaldMARKDOWN_FOLDER = docs-markdown/ 5503a627eSMilanka RingwaldMKDOCS_FOLDER = docs/ 6503a627eSMilanka RingwaldHTML_FOLDER = btstack/ 7c5d406ecSMatthias Ringwald 8503a627eSMilanka Ringwaldall: html pdf 9503a627eSMilanka Ringwald 10503a627eSMilanka Ringwalddocs-markdown: 11503a627eSMilanka Ringwald # create new docs_markdown 12503a627eSMilanka Ringwald rm -rf docs-markdown 13503a627eSMilanka Ringwald cp -r docs-template docs-markdown 14503a627eSMilanka Ringwald mkdir docs-markdown/examples 15503a627eSMilanka Ringwald mkdir docs-markdown/ports 16503a627eSMilanka Ringwald 17503a627eSMilanka Ringwald # create mkdocs.yml 18503a627eSMilanka Ringwald ./update_mkdocs_yml.sh 19503a627eSMilanka Ringwald 20503a627eSMilanka Ringwald # following should create files in docs-markdown 21503a627eSMilanka Ringwald 22503a627eSMilanka Ringwald # Use chipsets/readme as chipsets.md 23503a627eSMilanka Ringwald sed -e "s|../doc/manual/docs-template/||g" ../../chipset/README.md > docs-markdown/chipsets.md 24503a627eSMilanka Ringwald 25503a627eSMilanka Ringwald # create docs-markdown/appendix/apis.md 26503a627eSMilanka Ringwald # create docs-markdown/api_index.md 27*c8c342a6SMilanka Ringwald # create references.p 28*c8c342a6SMilanka Ringwald ./markdown_create_apis.py -r ${BTSTACK_FOLDER} -g ${GITHUB_URL} -o ${MARKDOWN_FOLDER} 29503a627eSMilanka Ringwald 30503a627eSMilanka Ringwald # create docs-markdown/examples/examples.md 31*c8c342a6SMilanka Ringwald ./markdown_create_examples.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER} 32503a627eSMilanka Ringwald 33503a627eSMilanka Ringwald # create docs-markdown/ports/existing_ports.md 34*c8c342a6SMilanka Ringwald ./markdown_create_ports.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER} 35503a627eSMilanka Ringwald 36503a627eSMilanka Ringwald # create docs-markdown/gatt_clients.md and docs-template/gatt_services.md 37*c8c342a6SMilanka Ringwald ./markdown_create_gatt_services_and_clients.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER} 38503a627eSMilanka Ringwald 39503a627eSMilanka Ringwalddocs: docs-markdown 40503a627eSMilanka Ringwald # create new docs_final 41503a627eSMilanka Ringwald rm -rf docs 42503a627eSMilanka Ringwald cp -r docs-markdown docs 43503a627eSMilanka Ringwald 44503a627eSMilanka Ringwald # docs-markdown -> docs 45*c8c342a6SMilanka Ringwald ./markdown_update_references.py -i ${MARKDOWN_FOLDER} -o ${MKDOCS_FOLDER} 46503a627eSMilanka Ringwald 47503a627eSMilanka Ringwald 48503a627eSMilanka Ringwaldhtml: docs 49503a627eSMilanka Ringwald # generate HTML into btstack folder 501ca3442bSMatthias Ringwald mkdocs build --clean 51c5d406ecSMatthias Ringwald 52*c8c342a6SMilanka Ringwald # post-process HTML using references.p 53*c8c342a6SMilanka Ringwald ./html_postprocess_code_blocks.py -o ${HTML_FOLDER} 54503a627eSMilanka Ringwald 55503a627eSMilanka Ringwaldpdf: docs 565b078273SMatthias Ringwald rm -rf latex 571ca3442bSMatthias Ringwald mkdir -p latex 581ca3442bSMatthias Ringwald cp -r docs/picts latex 59767003cdSMatthias Ringwald # create latex/btstack_gettingstartec.tex with version 60767003cdSMatthias Ringwald ./update_getting_started.sh 614f9c2a86SMatthias Ringwald # create latex/btstack_generated.md -> latex/btstack_final.tex 624f9c2a86SMatthias Ringwald ./markdown2tex.py 6345600c0eSMatthias Ringwald cp docs/ports/*.jpg latex 641ca3442bSMatthias Ringwald cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex 651ca3442bSMatthias Ringwald mv latex/btstack_gettingstarted.pdf btstack.pdf 661ca3442bSMatthias Ringwald 67503a627eSMilanka Ringwaldpreview: docs 68d5a53792SMatthias Ringwald # race condition, open browser before starting MKdocs server 6941d889f3SMilanka Ringwald open http://127.0.0.1:8010 7041d889f3SMilanka Ringwald mkdocs serve -a localhost:8010 71c5d406ecSMatthias Ringwald 72add0254bSMatthias Ringwaldclean: 73503a627eSMilanka Ringwald rm -rf docs-markdown docs tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex mkdocs.yml 744f9c2a86SMatthias Ringwald rm -rf latex btstack help 75*c8c342a6SMilanka Ringwald rm -rf references.p 761ca3442bSMatthias Ringwald 771ca3442bSMatthias Ringwald 78