2018-01-10 14:59:37 +00:00
|
|
|
all: update_content html pdf
|
2016-11-02 14:33:41 +00:00
|
|
|
|
2018-01-08 11:39:43 +00:00
|
|
|
html:
|
2017-12-23 21:22:41 +00:00
|
|
|
# docs -> docs_final
|
2015-06-18 14:33:34 +00:00
|
|
|
./markdown2mkdocs.py
|
2018-01-10 14:59:37 +00:00
|
|
|
# generate HTML
|
2015-05-05 10:07:25 +00:00
|
|
|
mkdocs build --clean
|
2018-01-10 14:59:37 +00:00
|
|
|
# post-process HTML
|
|
|
|
./mkdocs2html.py
|
2016-11-02 14:33:41 +00:00
|
|
|
|
|
|
|
pdf:
|
2018-01-10 14:59:37 +00:00
|
|
|
rm -rf latex
|
2015-06-05 15:38:11 +00:00
|
|
|
mkdir -p latex
|
|
|
|
cp -r docs/picts latex
|
2017-12-23 21:22:41 +00:00
|
|
|
# create latex/btstack_generated.md -> latex/btstack_final.tex
|
|
|
|
./markdown2tex.py
|
2015-06-05 15:38:11 +00:00
|
|
|
cp btstack_gettingstarted.tex latex
|
2017-12-23 22:39:25 +00:00
|
|
|
cp docs/ports/*.jpg latex
|
2015-06-05 15:38:11 +00:00
|
|
|
cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex
|
2015-06-18 14:33:34 +00:00
|
|
|
mv latex/btstack_gettingstarted.pdf btstack.pdf
|
2016-11-02 14:33:41 +00:00
|
|
|
|
2018-01-10 14:59:37 +00:00
|
|
|
preview: update_content html
|
2020-10-06 09:52:23 +00:00
|
|
|
# race condition, open browser before starting MKdocs server
|
2016-11-02 14:33:41 +00:00
|
|
|
open http://127.0.0.1:8000
|
|
|
|
mkdocs serve
|
|
|
|
|
2018-01-10 14:59:37 +00:00
|
|
|
update_content:
|
2016-11-18 17:20:25 +00:00
|
|
|
sed -e "s|../doc/manual/docs/||g" ../../chipset/README.md > docs/chipsets.md
|
2016-11-02 14:33:41 +00:00
|
|
|
rm -rf tmp
|
|
|
|
mkdir tmp
|
2020-10-06 09:52:23 +00:00
|
|
|
# create mkdocs.yml
|
|
|
|
./update_mkdocs_yml.sh
|
2017-12-23 21:22:41 +00:00
|
|
|
# create docs/appendix/apis.md
|
2016-11-02 14:33:41 +00:00
|
|
|
./update_apis.py
|
2017-12-23 21:22:41 +00:00
|
|
|
# create docs/examples/examples.md
|
2016-11-02 14:33:41 +00:00
|
|
|
./update_listings.py
|
2018-01-10 14:59:37 +00:00
|
|
|
# create docs/ports/existing_ports.md
|
|
|
|
./ports2markdown.py
|
|
|
|
# re-create docs_final
|
|
|
|
rm -rf docs_final
|
|
|
|
cp -r docs docs_final
|
2016-11-02 14:33:41 +00:00
|
|
|
|
2016-01-21 11:21:03 +00:00
|
|
|
clean:
|
2016-02-18 09:30:27 +00:00
|
|
|
rm -rf docs_final tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex
|
2016-11-18 17:16:17 +00:00
|
|
|
rm -rf docs/appendix/apis.md docs/appendix/index.md docs/examples/examples.md docs/chipsets.md
|
2017-12-23 21:22:41 +00:00
|
|
|
rm -rf latex btstack help
|
2016-03-09 09:34:41 +00:00
|
|
|
|
2015-06-05 13:20:02 +00:00
|
|
|
|
|
|
|
|