diff --git a/doc/manual/Makefile b/doc/manual/Makefile index 94ea4dc27..0dd14ba7e 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -20,7 +20,7 @@ pdf: mv latex/btstack_gettingstarted.pdf btstack.pdf preview: update_content html - # race condition, open browser before startnig MKdocs + # race condition, open browser before starting MKdocs server open http://127.0.0.1:8000 mkdocs serve @@ -28,6 +28,8 @@ update_content: sed -e "s|../doc/manual/docs/||g" ../../chipset/README.md > docs/chipsets.md rm -rf tmp mkdir tmp + # create mkdocs.yml + ./update_mkdocs_yml.sh # create docs/appendix/apis.md ./update_apis.py # create docs/examples/examples.md diff --git a/doc/manual/mkdocs.yml b/doc/manual/mkdocs-template.yml similarity index 95% rename from doc/manual/mkdocs.yml rename to doc/manual/mkdocs-template.yml index 72cba53fd..a69b3eb33 100644 --- a/doc/manual/mkdocs.yml +++ b/doc/manual/mkdocs-template.yml @@ -1,4 +1,4 @@ -site_name: BTstack Manual v1.0 +site_name: BTstack Manual VERSION site_dir: btstack docs_dir: docs_final extra_css: ['btstack.css'] diff --git a/doc/manual/update_mkdocs_yml.sh b/doc/manual/update_mkdocs_yml.sh new file mode 100755 index 000000000..2a93b3d05 --- /dev/null +++ b/doc/manual/update_mkdocs_yml.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env sh + +# get commit and tag +tag=`git tag --points-at` +commit=`git rev-parse --short HEAD` + +# use tag if available +if [ -z "$tag" ] +then + version=$commit +else + version=$tag +fi + +# create mkdocs.yml +sed -e "s|VERSION|$version|" mkdocs-template.yml > mkdocs.yml