1GITHUB_URL = "https://github.com/bluekitchen/btstack/tree/" 2BTSTACK_FOLDER = ../../ 3INTRO_FOLDER = docs-intro/ 4MARKDOWN_FOLDER = docs-markdown/ 5MKDOCS_FOLDER = docs/ 6HTML_FOLDER = btstack/ 7 8all: html pdf 9 10docs-markdown: 11 # create new docs_markdown 12 rm -rf docs-markdown 13 cp -r docs-template docs-markdown 14 mkdir docs-markdown/examples 15 mkdir docs-markdown/ports 16 17 # create mkdocs.yml 18 ./update_mkdocs_yml.sh 19 20 # following should create files in docs-markdown 21 22 # Use chipsets/readme as chipsets.md 23 sed -e "s|../doc/manual/docs-template/||g" ../../chipset/README.md > docs-markdown/chipsets.md 24 25 # create docs-markdown/appendix/apis.md 26 # create docs-markdown/api_index.md 27 # create docs-markdown/references.p 28 ./update_apis.py -r ${BTSTACK_FOLDER} -g ${GITHUB_URL} -o ${MARKDOWN_FOLDER} 29 30 # create docs-markdown/examples/examples.md 31 ./update_listings.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER} 32 33 # create docs-markdown/ports/existing_ports.md 34 ./ports2markdown.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER} 35 36 # create docs-markdown/gatt_clients.md and docs-template/gatt_services.md 37 ./update_gatt_services.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER} 38 39docs: docs-markdown 40 # create new docs_final 41 rm -rf docs 42 cp -r docs-markdown docs 43 44 # docs-markdown -> docs 45 ./markdown2mkdocs.py -i ${MARKDOWN_FOLDER} -o ${MKDOCS_FOLDER} 46 47 48html: docs 49 # generate HTML into btstack folder 50 mkdocs build --clean 51 52 # post-process HTML using docs-markdown/references.p 53 ./mkdocs2html.py -i ${MARKDOWN_FOLDER} -o ${HTML_FOLDER} 54 55pdf: docs 56 rm -rf latex 57 mkdir -p latex 58 cp -r docs/picts latex 59 # create latex/btstack_gettingstartec.tex with version 60 ./update_getting_started.sh 61 # create latex/btstack_generated.md -> latex/btstack_final.tex 62 ./markdown2tex.py 63 cp docs/ports/*.jpg latex 64 cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex 65 mv latex/btstack_gettingstarted.pdf btstack.pdf 66 67preview: docs 68 # race condition, open browser before starting MKdocs server 69 open http://127.0.0.1:8010 70 mkdocs serve -a localhost:8010 71 72clean: 73 rm -rf docs-markdown docs tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex mkdocs.yml 74 rm -rf latex btstack help 75 76 77 78