From 35e00af02830cb229ed3e32da61d3df119674b52 Mon Sep 17 00:00:00 2001 From: Matthias Ringwald Date: Fri, 18 Nov 2016 18:16:17 +0100 Subject: [PATCH] docs: move chipsets.md to chipsets/README.md, add to manual --- doc/manual/docs/chipsets.md => chipset/README.md | 0 doc/.gitignore | 1 + doc/manual/Makefile | 3 ++- doc/manual/mkdocs.yml | 5 +++-- 4 files changed, 6 insertions(+), 3 deletions(-) rename doc/manual/docs/chipsets.md => chipset/README.md (100%) create mode 100644 doc/.gitignore diff --git a/doc/manual/docs/chipsets.md b/chipset/README.md similarity index 100% rename from doc/manual/docs/chipsets.md rename to chipset/README.md diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 000000000..29a929f24 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1 @@ +chipsets.md diff --git a/doc/manual/Makefile b/doc/manual/Makefile index 4cda5ef33..578d63aab 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -26,6 +26,7 @@ preview: update_docs_and_apis html mkdocs serve update_docs_and_apis: + rsync -a ../../chipset/README.md docs/chipsets.md rm -rf tmp mkdir tmp ./update_apis.py @@ -33,7 +34,7 @@ update_docs_and_apis: clean: rm -rf docs_final tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex - rm -rf docs/appendix/apis.md docs/appendix/index.md docs/examples/examples.md + rm -rf docs/appendix/apis.md docs/appendix/index.md docs/examples/examples.md docs/chipsets.md rm -rf docs_tmp latex btstack help diff --git a/doc/manual/mkdocs.yml b/doc/manual/mkdocs.yml index 20250565a..007ceb315 100644 --- a/doc/manual/mkdocs.yml +++ b/doc/manual/mkdocs.yml @@ -6,10 +6,11 @@ pages: - [quick_start.md, Quick Start] - [architecture.md, BTstack Architecture] - [how_to.md, How to configure BTstack] -- [protocols.md, Supported Protocols] -- [profiles.md, Supported Profiles] +- [protocols.md, Protocols] +- [profiles.md, Profiles] - [gatt_services.md, Implemented GATT Services] - [examples/examples.md, Embedded Examples] +- [chipsets.md, Chipsets] - [porting.md, Porting to Other Platforms] - [integration.md, Integrating with Existing Systems] - [appendix/apis.md, APIs]