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 17*4a400a05SMilanka Ringwald # create mkdocs-temp.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 27c8c342a6SMilanka Ringwald # create references.p 28*4a400a05SMilanka Ringwald # create mkdocs.yml 29c8c342a6SMilanka Ringwald ./markdown_create_apis.py -r ${BTSTACK_FOLDER} -g ${GITHUB_URL} -o ${MARKDOWN_FOLDER} 30503a627eSMilanka Ringwald 31503a627eSMilanka Ringwald # create docs-markdown/examples/examples.md 32c8c342a6SMilanka Ringwald ./markdown_create_examples.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER} 33503a627eSMilanka Ringwald 34503a627eSMilanka Ringwald # create docs-markdown/ports/existing_ports.md 35c8c342a6SMilanka Ringwald ./markdown_create_ports.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER} 36503a627eSMilanka Ringwald 37503a627eSMilanka Ringwald # create docs-markdown/gatt_clients.md and docs-template/gatt_services.md 38c8c342a6SMilanka Ringwald ./markdown_create_gatt_services_and_clients.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER} 39503a627eSMilanka Ringwald 40503a627eSMilanka Ringwalddocs: docs-markdown 41*4a400a05SMilanka Ringwald # create new docs 42503a627eSMilanka Ringwald rm -rf docs 43503a627eSMilanka Ringwald cp -r docs-markdown docs 44503a627eSMilanka Ringwald 45503a627eSMilanka Ringwald # docs-markdown -> docs 46c8c342a6SMilanka Ringwald ./markdown_update_references.py -i ${MARKDOWN_FOLDER} -o ${MKDOCS_FOLDER} 47503a627eSMilanka Ringwald 48503a627eSMilanka Ringwald 49503a627eSMilanka Ringwaldhtml: docs 50503a627eSMilanka Ringwald # generate HTML into btstack folder 511ca3442bSMatthias Ringwald mkdocs build --clean 52c5d406ecSMatthias Ringwald 53c8c342a6SMilanka Ringwald # post-process HTML using references.p 54c8c342a6SMilanka Ringwald ./html_postprocess_code_blocks.py -o ${HTML_FOLDER} 55503a627eSMilanka Ringwald 56503a627eSMilanka Ringwaldpdf: docs 575b078273SMatthias Ringwald rm -rf latex 581ca3442bSMatthias Ringwald mkdir -p latex 591ca3442bSMatthias Ringwald cp -r docs/picts latex 60767003cdSMatthias Ringwald # create latex/btstack_gettingstartec.tex with version 61767003cdSMatthias Ringwald ./update_getting_started.sh 624f9c2a86SMatthias Ringwald # create latex/btstack_generated.md -> latex/btstack_final.tex 634f9c2a86SMatthias Ringwald ./markdown2tex.py 6445600c0eSMatthias Ringwald cp docs/ports/*.jpg latex 651ca3442bSMatthias Ringwald cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex 661ca3442bSMatthias Ringwald mv latex/btstack_gettingstarted.pdf btstack.pdf 671ca3442bSMatthias Ringwald 68503a627eSMilanka Ringwaldpreview: docs 69d5a53792SMatthias Ringwald # race condition, open browser before starting MKdocs server 7041d889f3SMilanka Ringwald open http://127.0.0.1:8010 7141d889f3SMilanka Ringwald mkdocs serve -a localhost:8010 72c5d406ecSMatthias Ringwald 73add0254bSMatthias Ringwaldclean: 74503a627eSMilanka Ringwald rm -rf docs-markdown docs tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex mkdocs.yml 754f9c2a86SMatthias Ringwald rm -rf latex btstack help 76*4a400a05SMilanka Ringwald rm -rf references.p mkdocs-temp.yml 771ca3442bSMatthias Ringwald 781ca3442bSMatthias Ringwald 79