summaryrefslogtreecommitdiffstats
path: root/mkdocs.yml
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2018-06-19 20:16:28 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2018-06-22 09:48:48 +0200
commit525e9eaa644ca92fad23adfbb7c3119ae8b57a30 (patch)
tree41de59627ccc937450daf4da6488efd4f4b2f3c2 /mkdocs.yml
parent9e15212d26916f59fae2be6d9e618ae9b75a4f40 (diff)
Improve documentation of api v3
The documentation is improved to reflect the new version. Tune the options Change-Id: I894c3db3bc0c10e89db66a9a51a9ad049bb8c0c4 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'mkdocs.yml')
-rw-r--r--mkdocs.yml28
1 files changed, 21 insertions, 7 deletions
diff --git a/mkdocs.yml b/mkdocs.yml
index b94263a1..48b90152 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,15 +1,29 @@
site_name: AGL Framework Binder
theme: readthedocs
docs_dir: docs
+# tr '*])([' "-''''" < docs/SUMMARY.md | sed "s/^\(.*'\)'/ \1: '/"
pages:
- 'Overview' : 'index.md'
+ - 'Binder Overview': 'afb-introduction.md'
+ - 'Binder daemon vocabulary': 'afb-daemon-vocabulary.md'
- 'How to write a binding ?': 'afb-binding-writing.md'
- - 'Binding references': 'afb-binding-references.md'
- - 'Migration from v1 to v2' : 'afb-migration-v1-to-v2.md'
- - 'Binder events guide' : 'afb-events-guide.md'
- - 'Binder Application writing guide' : 'afb-application-writing.md'
- - 'Binder daemon vocabulary' : 'afb-daemon-vocabulary.md'
- - 'Annexes':
+ - 'Binding references':
+ - 'Types and globals': 'reference-v3/types-and-globals.md'
+ - 'Functions of class afb_api': 'reference-v3/func-api.md'
+ - 'Functions of class afb_req': 'reference-v3/func-req.md'
+ - 'Functions of class afb_event': 'reference-v3/func-event.md'
+ - 'Functions of class afb_daemon': 'reference-v3/func-daemon.md'
+ - 'Functions of class afb_service': 'reference-v3/func-service.md'
+ - 'Macros for logging': 'reference-v3/macro-log.md'
+ - 'Binder events guide': 'afb-events-guide.md'
+ - 'Binder Application writing guide': 'afb-application-writing.md'
+ - 'Annexes':
+ - 'Migration to binding v3': 'afb-migration-to-binding-v3.md'
+ - 'WebSocket protocol x-afb-ws-json1': 'protocol-x-afb-ws-json1.md'
- 'Installing the binder on a desktop': 'afb-desktop-package.md'
- - 'Options of afb-daemon' : 'afb-daemon-options.md'
+ - 'Options of afb-daemon': 'afb-daemon-options.md'
+ - 'Debugging binder and bindings': 'afb-daemon-debugging.md'
+ - 'LEGACY Guide to migrate bindings from v1 to v2': 'legacy/afb-migration-v1-to-v2.md'
+ - 'LEGACY Binding V2 references': 'legacy/afb-binding-v2-references.md'
+ - 'Document revisions': 'REVISIONS.md'