mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-04-16 08:42:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: update for mkdocs 0.7.13

Browse Source
This commit is contained in:
Matthias Ringwald 2018-04-29 21:14:27 +02:00
parent e576eb5672
commit 63b4e1f271
3 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/manual/markdown2mkdocs.py
View File

@ -76,8 +76,9 @@ def main(argv):
with open(yml_file, 'r') as yin: with open(yml_file, 'r') as yin:
doc = yaml.load(yin) doc = yaml.load(yin)
for page in doc["pages"]: for page in doc["pages"]:
source_file = md_template +"/"+ page[0] mk_file = page.values()[0]
dest_file = md_final +"/"+ page[0] source_file = md_template +"/"+ mk_file
dest_file = md_final +"/"+ mk_file
print("Processing %s -> %s" % (source_file, dest_file)) print("Processing %s -> %s" % (source_file, dest_file))
with open(dest_file, 'w') as mdout: with open(dest_file, 'w') as mdout:
with open(source_file, 'r') as mdin: with open(source_file, 'r') as mdin:

4
doc/manual/markdown2tex.py
View File

@ -62,8 +62,8 @@ def main(argv):
with open(yml_file, 'r') as yin: with open(yml_file, 'r') as yin:
doc = yaml.load(yin) doc = yaml.load(yin)
for page in doc["pages"]: for page in doc["pages"]:
md_file = page[0] title = page.keys()[0]
title = page[1] md_file = page.values()[0]
with open(docs_folder +"/"+ md_file, 'r') as mdin: with open(docs_folder +"/"+ md_file, 'r') as mdin:
aout.write("\n\n#"+ title +"\n\n") aout.write("\n\n#"+ title +"\n\n")
for line in mdin: for line in mdin:

31
doc/manual/mkdocs.yml
View File

@ -1,20 +1,21 @@
site_name: BTstack Manual v1.0 site_name: BTstack Manual v1.0
site_dir: btstack site_dir: btstack
docs_dir: docs_final docs_dir: docs_final
extra_css: ['btstack.css']
pages: pages:
- [index.md, Welcome] - 'Welcome': index.md
- [quick_start.md, Quick Start] - 'Quick Start': quick_start.md
- [architecture.md, BTstack Architecture] - 'BTstack Architecture': architecture.md
- [how_to.md, How to configure BTstack] - 'How to configure Btstack': how_to.md
- [protocols.md, Protocols] - 'Protocols': protocols.md
- [profiles.md, Profiles] - 'Profiles': profiles.md
- [gatt_services.md, Implemented GATT Services] - 'Implemented GATT Services': gatt_services.md
- [examples/examples.md, Embedded Examples] - 'Embedded Examples': examples/examples.md
- [chipsets.md, Chipsets] - 'Chipsets': chipsets.md
- [porting.md, Porting to Other Platforms] - 'Porting to Other Platforms': porting.md
- [ports/existing_ports.md, Existing Ports] - 'Existing Ports': ports/existing_ports.md
- [integration.md, Integrating with Existing Systems] - 'Integrating with Existing Systems': integration.md
- [appendix/apis.md, APIs] - 'APIs': appendix/apis.md
- [appendix/events_errors.md, Events and Errors] - 'Eventts and Errors': appendix/events_errors.md
- [appendix/migration.md, Migration to v1.0] - 'Migration to v1.0': appendix/migration.md
theme: readthedocs theme: readthedocs