From 9661bbba26f9d9e42b9e60ae2d028e10dbe4ee7a Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Wed, 14 Nov 2018 10:45:13 +0100
Subject: new generation workflow: deported yaml files
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
The first new generation workflow,
it allows to deported yaml files into remote repositories.
Please see documentation at
https://github.com/automotive-grade-linux/docs-tools/blob/master-next/docs/NextGenWorkflow.pdf
New yaml files are named "section_<version>.yml" and point to the
deported yaml files named "book<...>.yaml" from remote repositories.
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/section_master.yml | 11 +++++++++++
1 file changed, 11 insertions(+)
create mode 100644 content/tocs/apis_services/section_master.yml
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
new file mode 100644
index 0000000..455117d
--- /dev/null
+++ b/content/tocs/apis_services/section_master.yml
@@ -0,0 +1,11 @@
+url_fetch : "GERRIT_FETCH"
+git_commit : "AGL_GERRIT_BRANCH"
+
+name: Developer Guides
+template: generated_index.html
+books:
+-
+ id: app-framework-binder-apis-services
+ url_fetch : "https://git.automotivelinux.org/src/app-framework-binder/plain/docs/app-framework-binder-book.yml?h=sandbox/benierc/newdocs"
+ path: docs/app-framework-binder-book.yml
+
--
cgit
From cde6cb1f1be5982b9d4e20c54072b21700f6e5dd Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Sun, 18 Nov 2018 23:21:02 +0100
Subject: new api service book
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/section_master.yml | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
index 455117d..d35c64b 100644
--- a/content/tocs/apis_services/section_master.yml
+++ b/content/tocs/apis_services/section_master.yml
@@ -8,4 +8,10 @@ books:
id: app-framework-binder-apis-services
url_fetch : "https://git.automotivelinux.org/src/app-framework-binder/plain/docs/app-framework-binder-book.yml?h=sandbox/benierc/newdocs"
path: docs/app-framework-binder-book.yml
-
+- id: message-signaling
+ url_fetch: "https://raw.githubusercontent.com/benierc/docs-sources/master/%source%"
+ path: docs/signaling-book.yml
+ books:
+ - id: high-level-viwi
+ url_fetch: "https://raw.githubusercontent.com/benierc/high-level-viwi-service/master/%source%"
+ path: docs/high-level-viwi-book.yml
--
cgit
From 73d78b467bc5e10ace5b8b775d29511773b5fd49 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Tue, 27 Nov 2018 10:17:39 -0800
Subject: API Landing Page: Added information for new API landing page
Updated the "fetched_files.yml" and "toc_dev_en.yml" files
so that a new landing page exists for the API reference.
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
---
content/tocs/apis_services/fetched_files.yml | 2 ++
content/tocs/apis_services/toc_dev_en.yml | 43 ++++++++++++++++------------
2 files changed, 27 insertions(+), 18 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml
index 95c2dcf..a554f57 100644
--- a/content/tocs/apis_services/fetched_files.yml
+++ b/content/tocs/apis_services/fetched_files.yml
@@ -49,6 +49,8 @@ repositories:
documents:
- source: 0-introduction.md
label: Introduction
+ - source: 0-kristi-introduction.md
+ label: API Reference
- source: 1-afm-daemons.md
label: The afm daemons
- source: 2-widgets.md
diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml
index 56cc4f3..1d16069 100644
--- a/content/tocs/apis_services/toc_dev_en.yml
+++ b/content/tocs/apis_services/toc_dev_en.yml
@@ -38,6 +38,11 @@
name: Developer Guides
template: generated_index.html
children:
+-
+ name: API Reference
+ children:
+ - url: reference/af-main/0-kristi-introduction.html
+
-
name: Application Framework
children:
@@ -80,24 +85,27 @@ children:
name: AGL Test Framework
children:
- url: reference/afb-test/Installation.html
- - url: reference/afb-test/write-the-tests.html
- - url: reference/afb-test/the-test-widget.html
- - url: reference/afb-test/launch-the-tests.html
- - url: reference/afb-test/tests-examples.html
- - name: References
+ - url: reference/afb-test/test-example.html
+ - url: reference/afb-test/launch-the-example.html
+ - name: Write Your Tests
children:
- - url: reference/afb-test/binding-test-functions.html
- - url: reference/afb-test/binding-assert-functions.html
- - url: reference/afb-test/test-framework-functions.html
- - name: LuaUnit Assertion Functions
- children:
- - url: reference/afb-test/general-assertions.html
- - url: reference/afb-test/value-assertions.html
- - url: reference/afb-test/scientific-assertions.html
- - url: reference/afb-test/string-assertions.html
- - url: reference/afb-test/error-assertions.html
- - url: reference/afb-test/type-assertions.html
- - url: reference/afb-test/table-assertions.html
+ - url: reference/afb-test/project-tree.html
+ - url: reference/afb-test/binding-configuration.html
+ - url: reference/afb-test/Lua-test-files.html
+ - name: References
+ children:
+ - url: reference/afb-test/binding-test-functions.html
+ - url: reference/afb-test/binding-assert-functions.html
+ - url: reference/afb-test/test-framework-functions.html
+ - name: LuaUnit Assertion Functions
+ children:
+ - url: reference/afb-test/general-assertions.html
+ - url: reference/afb-test/value-assertions.html
+ - url: reference/afb-test/scientific-assertions.html
+ - url: reference/afb-test/string-assertions.html
+ - url: reference/afb-test/error-assertions.html
+ - url: reference/afb-test/type-assertions.html
+ - url: reference/afb-test/table-assertions.html
-
name: Message Signaling
@@ -172,4 +180,3 @@ children:
children:
- url: reference/homescreen/homescreen_api.html
-
--
cgit
From 3b378aa49fbe91da3f144ad74087bd4771068729 Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Thu, 6 Dec 2018 18:00:18 +0100
Subject: fetched_files: fix 404 error
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/fetched_files.yml | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml
index a554f57..a279a5e 100644
--- a/content/tocs/apis_services/fetched_files.yml
+++ b/content/tocs/apis_services/fetched_files.yml
@@ -279,7 +279,7 @@ repositories:
- source: images/distributed-arch.png
- source: images/signal-service-arch.svg
-
- url_fetch: http://iot.bzh/download/public/2016/%source%
+ url_fetch: https://iot.bzh/download/public/2016/%source%
dst_prefix: iotbzh2016
documents:
- source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
@@ -340,12 +340,15 @@ repositories:
- source: ApplicationGuide.md
destination: 3_1-HomeScreen-Guide.md
label: Home Screen Developper Guide
- - source: parts/initialize.svg
- - source: parts/initialize-registercallback.svg
- source: parts/initialize-set-event-handler.svg
- source: parts/on_screen_message.svg
+ - source: parts/showInformation.svg
+ - source: parts/showNotification.svg
+ - source: parts/showOnScreen.svg
+ - source: parts/showWindow.svg
- source: parts/software-stack.png
- source: parts/tap_shortcut.svg
+
-
url_fetch: "GERRIT_FETCH"
git_name: apps/agl-service-windowmanager
@@ -357,7 +360,7 @@ repositories:
destination: 3_2-WindowManager-Guide.md
label: Window Manager Developper Guide
- source: parts/deactivate_window.png
- - source: parts/software-stack.png
+ - source: parts/wm_software_stack.png
- source: parts/example_split.png
- source: parts/state_change_example.png
- source: parts/hmi_framework_designed_seq_toyota.png
--
cgit
From 85d015213b015ec82d102ccfcbae0c6c4669978e Mon Sep 17 00:00:00 2001
From: Stéphane Desneux <stephane.desneux@iot.bzh>
Date: Thu, 6 Dec 2018 19:51:01 +0100
Subject: tocs: forward port from master branch
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
This commit ports the adjustments recently made on master branch
to the master-next branch, while keeping changes related to doc
reorganization.
Change-Id: I3d222bba1151bf0dd9136bed95a88bb2de9bdc24
Signed-off-by: Stéphane Desneux <stephane.desneux@iot.bzh>
---
content/tocs/apis_services/fetched_files.yml | 100 +++++++++++++--------------
content/tocs/apis_services/toc_dev_en.yml | 39 +++++------
2 files changed, 66 insertions(+), 73 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml
index a279a5e..f1709a0 100644
--- a/content/tocs/apis_services/fetched_files.yml
+++ b/content/tocs/apis_services/fetched_files.yml
@@ -5,8 +5,8 @@
#
# REPOSITORY ENTRY:
# -
-# url_fetch : gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit : gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
+# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
+# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
# git_name: repository name (%repo%)
# git_commit: git reference: revision, SHA1, branch... (%commit%)
# src_prefix: prefix prepended to %source%
@@ -37,14 +37,13 @@
# ------------------------------------
##############################################################################################################
-url_fetch : "GERRIT_FETCH"
-git_commit : "AGL_GERRIT_BRANCH"
+url_fetch: GERRIT_FETCH
+git_commit: AGL_GERRIT_BRANCH
repositories:
-
- git_name : src/app-framework-main
- git_commit: master
- src_prefix : docs
+ git_name: src/app-framework-main
+ src_prefix: docs
dst_prefix: af-main
documents:
- source: 0-introduction.md
@@ -70,9 +69,8 @@ repositories:
- source: pictures/triskel_iot_bzh.svg
-
- git_name : src/app-framework-binder
- git_commit: master
- src_prefix : docs
+ git_name: src/app-framework-binder
+ src_prefix: docs
dst_prefix: af-binder
documents:
- source: index.md
@@ -129,9 +127,8 @@ repositories:
- source: pictures/triskel_iot_bzh.svg
-
- git_name : apps/agl-service-can-low-level
- git_commit: master
- src_prefix : docs
+ git_name: apps/agl-service-can-low-level
+ src_prefix: docs
dst_prefix: signaling
documents:
- source: 1-Architecture.md
@@ -148,9 +145,8 @@ repositories:
- source: images/OpenXC_to_AGL.png
-
- git_name : apps/app-afb-test
- git_commit: master
- src_prefix : docs
+ git_name: apps/app-afb-test
+ src_prefix: docs
dst_prefix: afb-test
documents:
- source: 0_Installation.md
@@ -201,9 +197,10 @@ repositories:
-
url_fetch: GITHUB_FETCH
- git_name : iotbzh/high-level-viwi-service
+ url_edit: GITHUB_EDIT
+ git_name: iotbzh/high-level-viwi-service
git_commit: master
- src_prefix : docs
+ src_prefix: docs
dst_prefix: signaling
documents:
- source: 1-Architecture.md
@@ -214,9 +211,7 @@ repositories:
label: Installation and Usage Guide
- source: images/high-level-arch.png
-
- url_fetch: "GERRIT_FETCH"
git_name: apps/agl-service-signal-composer
- git_commit: "master"
src_prefix: docs/part-1/
dst_prefix: signaling
documents:
@@ -235,9 +230,10 @@ repositories:
- source: pictures/Global_Signaling_Architecture.png
- source: pictures/iotbzh_logo_small.png
-
- url_fetch: "GITHUB_FETCH"
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
git_name: iotbzh/agl-documentation
- git_commit: "master"
+ git_commit: master
documents:
- source: candevstudio/docs/1_Usage.md
- source: candevstudio/docs/2_can_device_socketcan_backend.md
@@ -250,8 +246,9 @@ repositories:
-
url_fetch: AGL_GITHUB_FETCH
- git_name: "automotive-grade-linux/docs-sources"
- git_commit: master-next
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: AGL_GITHUB_BRANCH
src_prefix: docs/app-framework
dst_prefix: af-binder
documents:
@@ -260,8 +257,9 @@ repositories:
label: Resources
-
url_fetch: AGL_GITHUB_FETCH
- git_name: "automotive-grade-linux/docs-sources"
- git_commit: master-next
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: AGL_GITHUB_BRANCH
src_prefix: docs/signaling
dst_prefix: signaling
documents:
@@ -287,8 +285,8 @@ repositories:
-
url_fetch: AGL_GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
- git_name: "automotive-grade-linux/docs-sources"
- git_commit: master-next
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: AGL_GITHUB_BRANCH
src_prefix: docs/audio
dst_prefix: audio
documents:
@@ -299,10 +297,8 @@ repositories:
destination: bluez-alsa.md
label: bluez-alsa
-
- url_fetch: "GERRIT_FETCH"
- git_commit : "AGL_GERRIT_BRANCH"
git_name: apps/agl-service-audio-4a
- src_prefix : docs
+ src_prefix: docs
dst_prefix: audio
documents:
- source: 4a-framework/README.md
@@ -331,46 +327,46 @@ repositories:
- source: high-level-api/TipsAndTricks/images/changeSound.png
- source: high-level-api/TipsAndTricks/images/MixerBaseMenu.png
-
- url_fetch: "GERRIT_FETCH"
+ git_name: src/pulseaudio-module-4a
+ dst_prefix: audio
+ documents:
+ - source: README.md
+ destination: pulseaudio-module-4a.md
+ label: Pulseaudio - 4A Integration Module
+-
git_name: apps/agl-service-homescreen
- git_commit: "master"
src_prefix: doc/
dst_prefix: hmi-framework/
documents:
- source: ApplicationGuide.md
destination: 3_1-HomeScreen-Guide.md
label: Home Screen Developper Guide
+ - source: parts/software-stack.png
- source: parts/initialize-set-event-handler.svg
+ - source: parts/tap_shortcut.svg
+ - source: parts/showWindow.svg
- source: parts/on_screen_message.svg
- - source: parts/showInformation.svg
- - source: parts/showNotification.svg
- source: parts/showOnScreen.svg
- - source: parts/showWindow.svg
- - source: parts/software-stack.png
- - source: parts/tap_shortcut.svg
-
+ - source: parts/showNotification.svg
+ - source: parts/showInformation.svg
-
- url_fetch: "GERRIT_FETCH"
git_name: apps/agl-service-windowmanager
- git_commit: "master"
src_prefix: doc/
dst_prefix: hmi-framework/
documents:
- source: ApplicationGuide.md
destination: 3_2-WindowManager-Guide.md
label: Window Manager Developper Guide
- - source: parts/deactivate_window.png
- - source: parts/wm_software_stack.png
- - source: parts/example_split.png
- source: parts/state_change_example.png
- - source: parts/hmi_framework_designed_seq_toyota.png
+ - source: parts/wm_software_stack.png
+ - source: parts/wm_layer_stack.png
- source: parts/wm_area.png
- source: parts/request_role.png
- - source: parts/wm_layer_stack.png
+ - source: parts/hmi_framework_designed_seq_toyota.png
+ - source: parts/deactivate_window.png
+ - source: parts/example_split.png
-
- url_fetch: "GERRIT_FETCH"
git_name: apps/agl-service-soundmanager
- git_commit: "master"
src_prefix: doc/
dst_prefix: hmi-framework/
documents:
@@ -398,11 +394,9 @@ repositories:
- source: parts/typical-usecase.png
- source: parts/am-component.png
-
- url_fetch : GERRIT_FETCH
- git_commit : master
- git_name : apps/homescreen
- src_prefix : homescreen/docs
- dst_prefix : homescreen
+ git_name: apps/homescreen
+ src_prefix: homescreen/docs
+ dst_prefix: homescreen
documents:
- source: homescreen_api.md
label: HomeScreen API
diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml
index 1d16069..023e699 100644
--- a/content/tocs/apis_services/toc_dev_en.yml
+++ b/content/tocs/apis_services/toc_dev_en.yml
@@ -85,27 +85,24 @@ children:
name: AGL Test Framework
children:
- url: reference/afb-test/Installation.html
- - url: reference/afb-test/test-example.html
- - url: reference/afb-test/launch-the-example.html
- - name: Write Your Tests
+ - url: reference/afb-test/write-the-tests.html
+ - url: reference/afb-test/the-test-widget.html
+ - url: reference/afb-test/launch-the-tests.html
+ - url: reference/afb-test/tests-examples.html
+ - name: References
children:
- - url: reference/afb-test/project-tree.html
- - url: reference/afb-test/binding-configuration.html
- - url: reference/afb-test/Lua-test-files.html
- - name: References
- children:
- - url: reference/afb-test/binding-test-functions.html
- - url: reference/afb-test/binding-assert-functions.html
- - url: reference/afb-test/test-framework-functions.html
- - name: LuaUnit Assertion Functions
- children:
- - url: reference/afb-test/general-assertions.html
- - url: reference/afb-test/value-assertions.html
- - url: reference/afb-test/scientific-assertions.html
- - url: reference/afb-test/string-assertions.html
- - url: reference/afb-test/error-assertions.html
- - url: reference/afb-test/type-assertions.html
- - url: reference/afb-test/table-assertions.html
+ - url: reference/afb-test/binding-test-functions.html
+ - url: reference/afb-test/binding-assert-functions.html
+ - url: reference/afb-test/test-framework-functions.html
+ - name: LuaUnit Assertion Functions
+ children:
+ - url: reference/afb-test/general-assertions.html
+ - url: reference/afb-test/value-assertions.html
+ - url: reference/afb-test/scientific-assertions.html
+ - url: reference/afb-test/string-assertions.html
+ - url: reference/afb-test/error-assertions.html
+ - url: reference/afb-test/type-assertions.html
+ - url: reference/afb-test/table-assertions.html
-
name: Message Signaling
@@ -147,6 +144,7 @@ children:
name: Audio Framework
children:
- url: reference/audio/bluez-alsa.html
+ - url: reference/audio/pulseaudio-module-4a.html
- name: 4a Framework
children:
- url: reference/audio/4a-framework/README.html
@@ -180,3 +178,4 @@ children:
children:
- url: reference/homescreen/homescreen_api.html
+
--
cgit
From 7e5900aa50d2be2362575e662c153f1e49c04f64 Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Wed, 12 Dec 2018 09:35:37 +0100
Subject: new yaml files
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/section_master.yml | 79 +++++++++++++++++++++++----
content/tocs/apis_services/toc_dev_en.yml | 2 +-
2 files changed, 70 insertions(+), 11 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
index d35c64b..6bfaf6b 100644
--- a/content/tocs/apis_services/section_master.yml
+++ b/content/tocs/apis_services/section_master.yml
@@ -5,13 +5,72 @@ name: Developer Guides
template: generated_index.html
books:
-
- id: app-framework-binder-apis-services
- url_fetch : "https://git.automotivelinux.org/src/app-framework-binder/plain/docs/app-framework-binder-book.yml?h=sandbox/benierc/newdocs"
- path: docs/app-framework-binder-book.yml
-- id: message-signaling
- url_fetch: "https://raw.githubusercontent.com/benierc/docs-sources/master/%source%"
- path: docs/signaling-book.yml
- books:
- - id: high-level-viwi
- url_fetch: "https://raw.githubusercontent.com/benierc/high-level-viwi-service/master/%source%"
- path: docs/high-level-viwi-book.yml
+ id: app-framework-main-developer-guides
+ git_name: src/app-framework-main
+ path: docs/api-services-book.yml
+-
+ id: app-framework-binder-developer-guides
+ git_name: src/app-framework-binder
+ path: docs/api-services-book.yml
+-
+ id: app-afb-test-developer-guides
+ git_name: apps/app-afb-test
+ path: docs/api-services-book.yml
+ #-
+ # id: docs-sources-developer-guides
+ # url_fetch: GITHUB_FETCH
+ # git_name: automotive-grade-linux/docs-sources
+ # path: docs/api-services-book.yml
+ # books:
+ # -
+ # id: agl-service-can-low-level-developer-guides
+ # git_name: apps/agl-service-can-low-level
+ # path: docs/api-services-book.yml
+ # -
+ # id: high-level-developer-guides
+ # url_fetch: GITHUB_FETCH
+ # git_name: iotbzh/high-level-viwi-service
+ # path: docs/api-services-book.yml
+ # -
+ # id: agl-service-signal-composer-developer-guides
+ # git_name: apps/agl-service-signal-composer
+ # path: docs/api-services-book.yml
+ ##- name: Developer Guidelines
+ ## url: reference/iotbzh2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+ ##- name: CAN Signaling Benchmark
+ ## url: reference/iotbzh2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ # -
+ # id: iotbzh-agl-documentation-developer-guides
+ # url_fetch: GITHUB_FETCH
+ # git_name: iotbzh/agl-documentation
+ # path: api-services-book.yml
+ #-
+ # id: agl-service-audio-4a-developer-guides
+ # git_name: apps/agl-service-audio-4a
+ # path: docs/api-services-book.yml
+ # -
+ # id: docs-sources-audio-developer-guides
+ # url_fetch: GITHUB_FETCH
+ # git_name: automotive-grade-linux/docs-sources
+ # path: docs/audio-api-services-book.yml
+ #-
+ # id: pulseaudio-module-4a-developer-guides
+ # git_name: src/pulseaudio-module-4a
+ # path: api-services-book.yml
+ #-
+ # id: agl-service-homescreen-developer-guides
+ # git_name: apps/agl-service-homescreen
+ # path: doc/api-services-book.yml
+ #-
+ # id: agl-service-windowmanager-developer-guides
+ # git_name: apps/agl-service-windowmanager
+ # path: doc/api-services-book.yml
+ #-
+ # id: agl-service-soundmanager-developer-guides
+ # git_name: apps/agl-service-soundmanager
+ # path: doc/api-services-book.yml
+ #-
+ # id: homescreen-developer-guides
+ # git_name: apps/homescreen
+ # path: api-services-book.yml
+ #
diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml
index 023e699..7737fcf 100644
--- a/content/tocs/apis_services/toc_dev_en.yml
+++ b/content/tocs/apis_services/toc_dev_en.yml
@@ -95,7 +95,7 @@ children:
- url: reference/afb-test/binding-assert-functions.html
- url: reference/afb-test/test-framework-functions.html
- name: LuaUnit Assertion Functions
- children:
+ children:
- url: reference/afb-test/general-assertions.html
- url: reference/afb-test/value-assertions.html
- url: reference/afb-test/scientific-assertions.html
--
cgit
From dcc03175f1c66fed1d057a9c33868956b4ca8f32 Mon Sep 17 00:00:00 2001
From: Frederic Marec <frederic.marec@iot.bzh>
Date: Fri, 21 Dec 2018 12:00:54 +0100
Subject: docs: Add new section_master yaml files
Bug-AGL: SPEC-1988
Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
---
content/tocs/apis_services/section_master.yml | 122 ++++++++++++++------------
1 file changed, 65 insertions(+), 57 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
index 6bfaf6b..b981da1 100644
--- a/content/tocs/apis_services/section_master.yml
+++ b/content/tocs/apis_services/section_master.yml
@@ -1,7 +1,7 @@
url_fetch : "GERRIT_FETCH"
git_commit : "AGL_GERRIT_BRANCH"
-name: Developer Guides
+name: APIs & Services
template: generated_index.html
books:
-
@@ -13,64 +13,72 @@ books:
git_name: src/app-framework-binder
path: docs/api-services-book.yml
-
- id: app-afb-test-developer-guides
- git_name: apps/app-afb-test
+ id: agl-service-can-low-level-developer-guides
+ git_name: apps/agl-service-can-low-level
path: docs/api-services-book.yml
- #-
- # id: docs-sources-developer-guides
- # url_fetch: GITHUB_FETCH
- # git_name: automotive-grade-linux/docs-sources
- # path: docs/api-services-book.yml
- # books:
- # -
- # id: agl-service-can-low-level-developer-guides
- # git_name: apps/agl-service-can-low-level
- # path: docs/api-services-book.yml
- # -
- # id: high-level-developer-guides
- # url_fetch: GITHUB_FETCH
- # git_name: iotbzh/high-level-viwi-service
- # path: docs/api-services-book.yml
- # -
- # id: agl-service-signal-composer-developer-guides
- # git_name: apps/agl-service-signal-composer
- # path: docs/api-services-book.yml
+#-
+# id: app-afb-test-developer-guides
+# git_name: apps/app-afb-test
+# path: docs/api-services-book.yml
+-
+ id: high-level-developer-guides
+ url_fetch: GITHUB_FETCH
+ git_name: iotbzh/high-level-viwi-service
+ path: docs/api-services-book.yml
+-
+ id: agl-service-signal-composer-developer-guides
+ git_name: apps/agl-service-signal-composer
+ path: docs/api-services-book.yml
+-
+ id: candevstudio-developer-guides
+ url_fetch: GITHUB_FETCH
+ git_name: iotbzh/agl-documentation
+ path: candevstudio/docs/api-services-book.yml
+-
+ id: app-framework-developer-guides
+ url_fetch: GITHUB_FETCH
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: sandbox/benierc/newdocs
+ path: docs/app-framework-book.yml
+-
+ id: signaling-developer-guides
+ url_fetch: GITHUB_FETCH
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: sandbox/benierc/newdocs
+ path: docs/signaling-book.yml
+
##- name: Developer Guidelines
## url: reference/iotbzh2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
##- name: CAN Signaling Benchmark
## url: reference/iotbzh2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
- # -
- # id: iotbzh-agl-documentation-developer-guides
- # url_fetch: GITHUB_FETCH
- # git_name: iotbzh/agl-documentation
- # path: api-services-book.yml
- #-
- # id: agl-service-audio-4a-developer-guides
- # git_name: apps/agl-service-audio-4a
- # path: docs/api-services-book.yml
- # -
- # id: docs-sources-audio-developer-guides
- # url_fetch: GITHUB_FETCH
- # git_name: automotive-grade-linux/docs-sources
- # path: docs/audio-api-services-book.yml
- #-
- # id: pulseaudio-module-4a-developer-guides
- # git_name: src/pulseaudio-module-4a
- # path: api-services-book.yml
- #-
- # id: agl-service-homescreen-developer-guides
- # git_name: apps/agl-service-homescreen
- # path: doc/api-services-book.yml
- #-
- # id: agl-service-windowmanager-developer-guides
- # git_name: apps/agl-service-windowmanager
- # path: doc/api-services-book.yml
- #-
- # id: agl-service-soundmanager-developer-guides
- # git_name: apps/agl-service-soundmanager
- # path: doc/api-services-book.yml
- #-
- # id: homescreen-developer-guides
- # git_name: apps/homescreen
- # path: api-services-book.yml
- #
+-
+ id: audio-developer-guides
+ url_fetch: GITHUB_FETCH
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: sandbox/benierc/newdocs
+ path: docs/audio-book.yml
+-
+ id: agl-service-audio-4a-developer-guides
+ git_name: apps/agl-service-audio-4a
+ path: docs/api-services-book.yml
+-
+ id: pulseaudio-module-4a-developer-guides
+ git_name: src/pulseaudio-module-4a
+ path: api-services-book.yml
+-
+ id: agl-service-homescreen-developer-guides
+ git_name: apps/agl-service-homescreen
+ path: doc/api-services-book.yml
+-
+ id: agl-service-windowmanager-developer-guides
+ git_name: apps/agl-service-windowmanager
+ path: doc/api-services-book.yml
+-
+ id: agl-service-soundmanager-developer-guides
+ git_name: apps/agl-service-soundmanager
+ path: doc/api-services-book.yml
+-
+ id: homescreen-developer-guides
+ git_name: apps/homescreen
+ path: homescreen/docs/api-services-book.yml
+
--
cgit
From 783a8763bdf440818d4ba61d4b1b511d317cb90f Mon Sep 17 00:00:00 2001
From: Sebastien Douheret <sebastien.douheret@iot.bzh>
Date: Sat, 22 Dec 2018 21:24:36 +0100
Subject: Add missing url_edit and dst_prefix fields
Change-Id: I98e44f3b7abe9403d0a1f2eeaa1cec1ef1ff30e1
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
---
content/tocs/apis_services/section_master.yml | 35 ++++++++++++++++++++++-----
1 file changed, 29 insertions(+), 6 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
index b981da1..ae56813 100644
--- a/content/tocs/apis_services/section_master.yml
+++ b/content/tocs/apis_services/section_master.yml
@@ -8,23 +8,30 @@ books:
id: app-framework-main-developer-guides
git_name: src/app-framework-main
path: docs/api-services-book.yml
+ dst_prefix: af-main
-
id: app-framework-binder-developer-guides
git_name: src/app-framework-binder
path: docs/api-services-book.yml
+ dst_prefix: af-binder
-
id: agl-service-can-low-level-developer-guides
git_name: apps/agl-service-can-low-level
path: docs/api-services-book.yml
+ dst_prefix: signaling
+# FIXME
#-
# id: app-afb-test-developer-guides
# git_name: apps/app-afb-test
# path: docs/api-services-book.yml
+# dst_prefix: afb-test
-
id: high-level-developer-guides
url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
git_name: iotbzh/high-level-viwi-service
path: docs/api-services-book.yml
+ dst_prefix: signaling
-
id: agl-service-signal-composer-developer-guides
git_name: apps/agl-service-signal-composer
@@ -32,53 +39,69 @@ books:
-
id: candevstudio-developer-guides
url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
git_name: iotbzh/agl-documentation
path: candevstudio/docs/api-services-book.yml
+ dst_prefix: candevstudio
-
id: app-framework-developer-guides
url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
git_name: automotive-grade-linux/docs-sources
git_commit: sandbox/benierc/newdocs
path: docs/app-framework-book.yml
+ dst_prefix: af-binder
-
id: signaling-developer-guides
url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
git_name: automotive-grade-linux/docs-sources
git_commit: sandbox/benierc/newdocs
path: docs/signaling-book.yml
-
- ##- name: Developer Guidelines
- ## url: reference/iotbzh2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
- ##- name: CAN Signaling Benchmark
- ## url: reference/iotbzh2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ src_prefix: docs/signaling
+# FIXME
+# -
+# id: devel-guidelines-2016
+# url_fetch: https://iot.bzh/download/public/2016/%source%
+# dst_prefix: iotbzh2016
+# documents:
+# - source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+# - source: signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
-
id: audio-developer-guides
url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
git_name: automotive-grade-linux/docs-sources
git_commit: sandbox/benierc/newdocs
path: docs/audio-book.yml
+ dst_prefix: audio
-
id: agl-service-audio-4a-developer-guides
git_name: apps/agl-service-audio-4a
path: docs/api-services-book.yml
+ dst_prefix: audio
-
id: pulseaudio-module-4a-developer-guides
git_name: src/pulseaudio-module-4a
path: api-services-book.yml
+ dst_prefix: audio
-
id: agl-service-homescreen-developer-guides
git_name: apps/agl-service-homescreen
path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
-
id: agl-service-windowmanager-developer-guides
git_name: apps/agl-service-windowmanager
path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
-
id: agl-service-soundmanager-developer-guides
git_name: apps/agl-service-soundmanager
path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
-
id: homescreen-developer-guides
git_name: apps/homescreen
path: homescreen/docs/api-services-book.yml
-
+ dst_prefix: hmi-framework
--
cgit
From c62f3d3b8a7d996bec5ce181a5b245d792796cc2 Mon Sep 17 00:00:00 2001
From: Sebastien Douheret <sebastien.douheret@iot.bzh>
Date: Sat, 22 Dec 2018 21:26:36 +0100
Subject: Remove fetched and toc yaml files (old method)
Change-Id: I515d45f197a815bb2b169ba0380ef0e8b7fbc4f8
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
---
content/tocs/apis_services/fetched_files.yml | 420 ---------------------------
content/tocs/apis_services/toc_dev_en.yml | 181 ------------
2 files changed, 601 deletions(-)
delete mode 100644 content/tocs/apis_services/fetched_files.yml
delete mode 100644 content/tocs/apis_services/toc_dev_en.yml
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml
deleted file mode 100644
index f1709a0..0000000
--- a/content/tocs/apis_services/fetched_files.yml
+++ /dev/null
@@ -1,420 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-url_fetch: GERRIT_FETCH
-git_commit: AGL_GERRIT_BRANCH
-
-repositories:
--
- git_name: src/app-framework-main
- src_prefix: docs
- dst_prefix: af-main
- documents:
- - source: 0-introduction.md
- label: Introduction
- - source: 0-kristi-introduction.md
- label: API Reference
- - source: 1-afm-daemons.md
- label: The afm daemons
- - source: 2-widgets.md
- label: Widgets
- - source: 2.1-widgets.md
- label: Overview of widgets
- - source: 2.2-config.xml.md
- label: Widget configuration file
- - source: 3-permissions.md
- label: Permissions
- - source: 4-quick-tutorial.md
- label: Quick Tutorial
- - source: pictures/afm-daemons.svg
- - source: pictures/AppFW-APP_install_sequences.svg
- - source: pictures/make-units.svg
- - source: pictures/Security_model_history.svg
- - source: pictures/triskel_iot_bzh.svg
-
--
- git_name: src/app-framework-binder
- src_prefix: docs
- dst_prefix: af-binder
- documents:
- - source: index.md
- label: Binder index
- - source: afb-overview.md
- label: Overview
- - source: afb-binding-writing.md
- label: How to write a binding ?
- - source: afb-binding-references.md
- label: Binding references
- - source: reference-v3/types-and-globals.md
- label: Types and globals
- - source: reference-v3/func-api.md
- label: Functions of class afb_api
- - source: reference-v3/func-req.md
- label: Functions of class afb_req
- - source: reference-v3/func-event.md
- label: Functions of class afb_event
- - source: reference-v3/func-daemon.md
- label: Functions of class afb_daemon
- - source: reference-v3/func-service.md
- label: Functions of class afb_service
- - source: reference-v3/macro-log.md
- label: Macros for logging
- - source: afb-migration-to-binding-v3.md
- label: Migration to bindings v3
- - source: afb-events-guide.md
- label: Binder events guide
- - source: afb-application-writing.md
- label: Binder Application writing guide
- - source: afb-daemon-vocabulary.md
- label: Binder daemon vocabulary
- - source: afb-desktop-package.md
- label: Installing the binder on a desktop
- - source: afb-daemon-debugging.md
- label: Debugging binder and bindings
- - source: afb-daemon-options.md
- label: Options of afb-daemon
- - source: protocol-x-afb-ws-json1.md
- label: WebSocket protocol x-afb-ws-json1
- - source: annexes.md
- label: Annexes
- - source: REVISIONS.md
- label: Document revision
- - source: legacy/afb-migration-v1-to-v2.md
- label: LEGACY Migration from v1 to v2
- - source: legacy/afb-binding-v2-references.md
- label: LEGACY Binding V2 references
- - source: pictures/AFB_for_services.svg
- - source: pictures/basis.svg
- - source: pictures/interconnection.svg
- - source: pictures/signaling-basis.svg
- - source: pictures/tic-tac-toe.svg
- - source: pictures/triskel_iot_bzh.svg
-
--
- git_name: apps/agl-service-can-low-level
- src_prefix: docs
- dst_prefix: signaling
- documents:
- - source: 1-Architecture.md
- destination: low-can-architecture.md
- label: Architecture presentation
- - source: 2-Installation.md
- destination: low-can-installation-guide.md
- label: Installation Guide
- - source: 3-Usage.md
- destination: low-can-usage-guide.md
- label: Usage Guide
- - source: images/CAN_bindings_communication.png
- - source: images/CAN_level_mapping.png
- - source: images/OpenXC_to_AGL.png
-
--
- git_name: apps/app-afb-test
- src_prefix: docs
- dst_prefix: afb-test
- documents:
- - source: 0_Installation.md
- destination: Installation.md
- label: Installation
- - source: 1_Write_the_tests.md
- destination: write-the-tests.md
- label: Write the tests
- - source: 2_The_test_widget.md
- destination: the-test-widget.md
- label: The test widget
- - source: 3_Launch_the_tests.md
- destination: launch-the-tests.md
- label: Launch the tests
- - source: 4_Tests_Examples.md
- destination: tests-examples.md
- label: Tests examples
- - source: Reference/0_BindingTestFunctions.md
- destination: binding-test-functions.md
- label: Binding Test Functions
- - source: Reference/1_BindingAssertFunctions.md
- destination: binding-assert-functions.md
- label: Binding Assert Functions
- - source: Reference/2_TestFrameworkFunctions.md
- destination: test-framework-functions.md
- label: Test Framework Functions
- - source: Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md
- destination: general-assertions.md
- label: General Assertions
- - source: Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md
- destination: value-assertions.md
- label: Value Assertions
- - source: Reference/LuaUnitAssertionFunctions/2_ScientificAssertions.md
- destination: scientific-assertions.md
- label: Scientific Assertions
- - source: Reference/LuaUnitAssertionFunctions/3_StringAssertions.md
- destination: string-assertions.md
- label: String Assertions
- - source: Reference/LuaUnitAssertionFunctions/4_ErrorAssertions.md
- destination: error-assertions.md
- label: Error Assertions
- - source: Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md
- destination: type-assertions.md
- label: Type Assertions
- - source: Reference/LuaUnitAssertionFunctions/6_TableAssertions.md
- destination: table-assertions.md
- label: Table Assertions
-
--
- url_fetch: GITHUB_FETCH
- url_edit: GITHUB_EDIT
- git_name: iotbzh/high-level-viwi-service
- git_commit: master
- src_prefix: docs
- dst_prefix: signaling
- documents:
- - source: 1-Architecture.md
- destination: high-viwi-architecture.md
- label: Architecture presentation
- - source: 2-Install-Usage.md
- destination: high-viwi-install-usage-guide.md
- label: Installation and Usage Guide
- - source: images/high-level-arch.png
--
- git_name: apps/agl-service-signal-composer
- src_prefix: docs/part-1/
- dst_prefix: signaling
- documents:
- - source: 1-Architecture.md
- destination: signal-composer-architecture.md
- label: Architecture presentation
- - source: 2-Configuration.md
- destination: signal-composer-configuration.md
- label: Configuration
- - source: 3-Plugins.md
- destination: signal-composer-plugins.md
- label: Plugins
- - source: 4-SignalComposerAPI.md
- destination: signal-composer-api.md
- label: Signal Composer API
- - source: pictures/Global_Signaling_Architecture.png
- - source: pictures/iotbzh_logo_small.png
--
- url_fetch: GITHUB_FETCH
- url_edit: GITHUB_EDIT
- git_name: iotbzh/agl-documentation
- git_commit: master
- documents:
- - source: candevstudio/docs/1_Usage.md
- - source: candevstudio/docs/2_can_device_socketcan_backend.md
- - source: candevstudio/docs/3_Add_CAN_Device.md
- - source: candevstudio/docs/4_Configure_CanRawSender_Node.md
- - source: candevstudio/docs/5_Using_CanRawView.md
- - source: candevstudio/docs/pictures/CANdevStudio.png
- - source: candevstudio/docs/pictures/canrawsender.png
- - source: candevstudio/docs/pictures/canrawviewer.png
-
--
- url_fetch: AGL_GITHUB_FETCH
- url_edit: AGL_GITHUB_EDIT
- git_name: automotive-grade-linux/docs-sources
- git_commit: AGL_GITHUB_BRANCH
- src_prefix: docs/app-framework
- dst_prefix: af-binder
- documents:
- - source: index.md
- destination: resources.md
- label: Resources
--
- url_fetch: AGL_GITHUB_FETCH
- url_edit: AGL_GITHUB_EDIT
- git_name: automotive-grade-linux/docs-sources
- git_commit: AGL_GITHUB_BRANCH
- src_prefix: docs/signaling
- dst_prefix: signaling
- documents:
- - source: architecture.md
- destination: architecture.md
- label: Signaling Architecture
- - source: index.md
- destination: resources.md
- label: Resources
- - source: images/agent-arch.svg
- - source: images/agent-sample.svg
- - source: images/cloud-arch.svg
- - source: images/can-generator.svg
- - source: images/distributed-arch.svg
- - source: images/distributed-arch.png
- - source: images/signal-service-arch.svg
--
- url_fetch: https://iot.bzh/download/public/2016/%source%
- dst_prefix: iotbzh2016
- documents:
- - source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
- - source: signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
--
- url_fetch: AGL_GITHUB_FETCH
- url_edit: AGL_GITHUB_EDIT
- git_name: automotive-grade-linux/docs-sources
- git_commit: AGL_GITHUB_BRANCH
- src_prefix: docs/audio
- dst_prefix: audio
- documents:
- - source: 4a-framework.md
- destination: 4a-framework.md
- label: 4a-framework
- - source: bluez-alsa.md
- destination: bluez-alsa.md
- label: bluez-alsa
--
- git_name: apps/agl-service-audio-4a
- src_prefix: docs
- dst_prefix: audio
- documents:
- - source: 4a-framework/README.md
- label: Architecture
- - source: 4a-framework/concepts.md
- label: Concepts
- - source: 4a-framework/components.md
- label: Components
- - source: 4a-framework/images/4a-architecture.svg
- - source: 4a-framework/images/apps-architecture.svg
- - source: 4a-framework/images/agl-audio-arch.png
- - source: high-level-api/README.md
- label: Abstract
- - source: high-level-api/kickstart.md
- label: Kickstart
- - source: high-level-api/reference.md
- label: Reference
- - source: high-level-api/TipsAndTricks/AdjustVolumes.md
- label: Adjust volumes
- - source: high-level-api/TipsAndTricks/4aTools.md
- label: 4a-tools
- - source: high-level-api/TipsAndTricks/Devices.md
- label: Devices
- - source: high-level-api/TipsAndTricks/HALs.md
- label: HALs
- - source: high-level-api/TipsAndTricks/images/changeSound.png
- - source: high-level-api/TipsAndTricks/images/MixerBaseMenu.png
--
- git_name: src/pulseaudio-module-4a
- dst_prefix: audio
- documents:
- - source: README.md
- destination: pulseaudio-module-4a.md
- label: Pulseaudio - 4A Integration Module
--
- git_name: apps/agl-service-homescreen
- src_prefix: doc/
- dst_prefix: hmi-framework/
- documents:
- - source: ApplicationGuide.md
- destination: 3_1-HomeScreen-Guide.md
- label: Home Screen Developper Guide
- - source: parts/software-stack.png
- - source: parts/initialize-set-event-handler.svg
- - source: parts/tap_shortcut.svg
- - source: parts/showWindow.svg
- - source: parts/on_screen_message.svg
- - source: parts/showOnScreen.svg
- - source: parts/showNotification.svg
- - source: parts/showInformation.svg
--
- git_name: apps/agl-service-windowmanager
- src_prefix: doc/
- dst_prefix: hmi-framework/
- documents:
- - source: ApplicationGuide.md
- destination: 3_2-WindowManager-Guide.md
- label: Window Manager Developper Guide
- - source: parts/state_change_example.png
- - source: parts/wm_software_stack.png
- - source: parts/wm_layer_stack.png
- - source: parts/wm_area.png
- - source: parts/request_role.png
- - source: parts/hmi_framework_designed_seq_toyota.png
- - source: parts/deactivate_window.png
- - source: parts/example_split.png
--
- git_name: apps/agl-service-soundmanager
- src_prefix: doc/
- dst_prefix: hmi-framework/
- documents:
- - source: ApplicationGuide.md
- destination: 3_3-SoundManager-Guide.md
- label: Sound Manager Developper Guide
- - source: Display_Audio_Transition1.md
- destination: Display_Audio_Transition1.md
- label: Sound Manager Developper Guide 2
- - source: Display_Audio_Transition2.md
- destination: Display_Audio_Transition2.md
- label: Sound Manager Developper Guide 3
- - source: parts/seq_startup.svg
- - source: parts/am-component.png
- - source: parts/seq_registration.svg
- - source: parts/seq_connectsoundroute.svg
- - source: parts/seq_startsoundstreaming.svg
- - source: parts/seq_requestsoundmode.svg
- - source: parts/seq_setmutestate.svg
- - source: parts/seq_changevolume.svg
- - source: parts/seq_stopsoundstreaming.svg
- - source: parts/seq_disconnectsoundroute.svg
- - source: parts/software-stack.png
- - source: parts/seq_releasesoundmode.svg
- - source: parts/typical-usecase.png
- - source: parts/am-component.png
--
- git_name: apps/homescreen
- src_prefix: homescreen/docs
- dst_prefix: homescreen
- documents:
- - source: homescreen_api.md
- label: HomeScreen API
- - source: pictures/api_getAllSurfacesOfProcess.png
- destination: pictures/api_getAllSurfacesOfProcess.png
- - source: pictures/api_getSurfaceStatus_1.png
- destination: pictures/api_getSurfaceStatus_1.png
- - source: pictures/api_getSurfaceStatus_2.png
- destination: pictures/api_getSurfaceStatus_2.png
- - source: pictures/api_getSurfaceStatus_3.png
- destination: pictures/api_getSurfaceStatus_3.png
- - source: pictures/api_hardKeyPressed.png
- destination: pictures/api_hardKeyPressed.png
- - source: pictures/api_renderSurfaceToArea.png
- destination: pictures/api_renderSurfaceToArea.png
- - source: pictures/api_renderSurfaceToAreaAllowed.png
- destination: pictures/api_renderSurfaceToAreaAllowed.png
- - source: pictures/api_requestSurfaceIdToFullScreen.png
- destination: pictures/api_requestSurfaceIdToFullScreen.png
- - source: pictures/api_surfaceVisibilityChanged.png
- destination: pictures/api_surfaceVisibilityChanged.png
diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml
deleted file mode 100644
index 7737fcf..0000000
--- a/content/tocs/apis_services/toc_dev_en.yml
+++ /dev/null
@@ -1,181 +0,0 @@
-#######################################################################
-# WARNING:
-# - TOC should reference .HTML and .md (Index OK but Error 404)
-# - do not forget to run 'docbuild --tocs' after any changes
-#
-#
-############################ SYNTAX ###################################
-# GLOBAL OPTIONS:
-# name: TOC (page) title
-# template: name of template to use for this page - use 'generated_index.html' if unknown
-# children: array of TOC entries
-#
-# TOC Entry:
-# name: TOC entry (level 1)
-# children:
-# -
-# name: optional name for TOC entry (default: use URL FrontMatter info)
-# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js:
-# -
-# name: ...
-# url: ...
-# ...
-#
-# EXAMPLE:
-# -------------------------------
-# name: Developer Guides
-# template: generated_index.html
-# children:
-# -
-# name: Application Framework
-# children:
-# - url: reference/af-main/overview.html
-# - url: reference/af-main/afm-system-daemon.html
-# - url: reference/af-main/afm-user-daemon.html
-# -------------------------------
-#######################################################################
-
-name: Developer Guides
-template: generated_index.html
-children:
--
- name: API Reference
- children:
- - url: reference/af-main/0-kristi-introduction.html
-
--
- name: Application Framework
- children:
- - url: reference/af-main/0-introduction.html
- - url: reference/af-main/1-afm-daemons.html
- - url: reference/af-main/2-widgets.html
- - url: reference/af-main/2.1-widgets.html
- - url: reference/af-main/2.2-config.xml.html
- - url: reference/af-main/3-permissions.html
- - url: reference/af-main/4-quick-tutorial.html
--
- name: Application Framework Binder
- children:
- - url: reference/af-binder/afb-overview.html
- - url: reference/af-binder/afb-daemon-vocabulary.html
- - url: reference/af-binder/afb-binding-writing.html
- - name: Binder references
- children:
- - url: reference/af-binder/reference-v3/types-and-globals.html
- - url: reference/af-binder/reference-v3/macro-log.html
- - url: reference/af-binder/reference-v3/func-api.html
- - url: reference/af-binder/reference-v3/func-req.html
- - url: reference/af-binder/reference-v3/func-event.html
- - url: reference/af-binder/reference-v3/func-daemon.html
- - url: reference/af-binder/reference-v3/func-service.html
- - url: reference/af-binder/afb-events-guide.html
- - url: reference/af-binder/afb-application-writing.html
- - name: Annexes
- children:
- - url: reference/af-binder/afb-migration-to-binding-v3.html
- - url: reference/af-binder/protocol-x-afb-ws-json1.html
- - url: reference/af-binder/afb-desktop-package.html
- - url: reference/af-binder/afb-daemon-options.html
- - url: reference/af-binder/afb-daemon-debugging.html
- - url: reference/af-binder/legacy/afb-migration-v1-to-v2.html
- - url: reference/af-binder/legacy/afb-binding-v2-references.html
- - url: reference/af-binder/REVISIONS.html
-
--
- name: AGL Test Framework
- children:
- - url: reference/afb-test/Installation.html
- - url: reference/afb-test/write-the-tests.html
- - url: reference/afb-test/the-test-widget.html
- - url: reference/afb-test/launch-the-tests.html
- - url: reference/afb-test/tests-examples.html
- - name: References
- children:
- - url: reference/afb-test/binding-test-functions.html
- - url: reference/afb-test/binding-assert-functions.html
- - url: reference/afb-test/test-framework-functions.html
- - name: LuaUnit Assertion Functions
- children:
- - url: reference/afb-test/general-assertions.html
- - url: reference/afb-test/value-assertions.html
- - url: reference/afb-test/scientific-assertions.html
- - url: reference/afb-test/string-assertions.html
- - url: reference/afb-test/error-assertions.html
- - url: reference/afb-test/type-assertions.html
- - url: reference/afb-test/table-assertions.html
-
--
- name: Message Signaling
- children:
- - url: reference/signaling/architecture.html
- - name: Low level CAN service Guide
- children:
- - url: reference/signaling/low-can-architecture.html
- - url: reference/signaling/low-can-installation-guide.html
- - url: reference/signaling/low-can-usage-guide.html
- - name: High level ViWi service Guide
- children:
- - url: reference/signaling/high-viwi-architecture.html
- - url: reference/signaling/high-viwi-install-usage-guide.html
- - name: Signal Composer service Guide
- children:
- - url: reference/signaling/signal-composer-architecture.html
- - url: reference/signaling/signal-composer-configuration.html
- - url: reference/signaling/signal-composer-plugins.html
- - url: reference/signaling/signal-composer-api.html
- - name: Developer Guidelines
- url: reference/iotbzh2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
- - name: CAN Signaling Benchmark
- url: reference/iotbzh2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
- - name: CanDevStudio Quickstart
- children:
- - name: Usage Guide
- url: reference/candevstudio/docs/1_Usage.html
- - name: Bringing up a CAN device using socketcan backend
- url: reference/candevstudio/docs/2_can_device_socketcan_backend.html
- - name: Add a CAN device in CANdevStudio
- url: reference/candevstudio/docs/3_Add_CAN_Device.html
- - name: Configure a CanRawSender node
- url: reference/candevstudio/docs/4_Configure_CanRawSender_Node.html
- - name: Using CanRawView
- url: reference/candevstudio/docs/5_Using_CanRawView.html
- - url: reference/signaling/resources.html
--
- name: Audio Framework
- children:
- - url: reference/audio/bluez-alsa.html
- - url: reference/audio/pulseaudio-module-4a.html
- - name: 4a Framework
- children:
- - url: reference/audio/4a-framework/README.html
- - url: reference/audio/4a-framework/concepts.html
- - url: reference/audio/4a-framework/components.html
- - name: high-level-api
- children:
- - url: reference/audio/high-level-api/README.html
- - url: reference/audio/high-level-api/kickstart.html
- - url: reference/audio/high-level-api/reference.html
- - name: Tips And Tricks
- children:
- - url: reference/audio/high-level-api/TipsAndTricks/AdjustVolumes.html
- - url: reference/audio/high-level-api/TipsAndTricks/4aTools.html
- - url: reference/audio/high-level-api/TipsAndTricks/Devices.html
- - url: reference/audio/high-level-api/TipsAndTricks/HALs.html
--
- name: HMI Framework
- children:
- -
- name: Home Screen Developper Guide
- url: reference/hmi-framework/3_1-HomeScreen-Guide.html
- -
- name: Window Manager Developper Guide
- url: reference/hmi-framework/3_2-WindowManager-Guide.html
- -
- name: Sound Manager Developper Guide
- url: reference/hmi-framework/3_3-SoundManager-Guide.html
--
- name: HomeScreen (old)
- children:
- - url: reference/homescreen/homescreen_api.html
-
-
--
cgit
From d862e85ca1ab33490557929accb9e750c7c0968b Mon Sep 17 00:00:00 2001
From: Frederic Marec <frederic.marec@iot.bzh>
Date: Wed, 9 Jan 2019 14:49:38 +0100
Subject: Add yaml files for flounder version
Add yaml files for flounder version documentation
Uncomment app-afb-test part for apis_services section
Add node_modules & package.json in .gitignore
Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
---
content/tocs/apis_services/section_flounder.yml | 108 ++++++++++++++++++++++++
content/tocs/apis_services/section_master.yml | 11 ++-
2 files changed, 113 insertions(+), 6 deletions(-)
create mode 100644 content/tocs/apis_services/section_flounder.yml
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml
new file mode 100644
index 0000000..ceb1912
--- /dev/null
+++ b/content/tocs/apis_services/section_flounder.yml
@@ -0,0 +1,108 @@
+url_fetch : "GERRIT_FETCH"
+git_commit : "flounder"
+
+name: APIs & Services
+template: generated_index.html
+books:
+-
+ id: app-framework-main-developer-guides-flounder
+ git_name: src/app-framework-main
+ path: docs/api-services-book.yml
+ dst_prefix: af-main
+-
+ id: app-framework-binder-developer-guides-flounder
+ git_name: src/app-framework-binder
+ path: docs/api-services-book.yml
+ dst_prefix: af-binder
+-
+ id: agl-service-can-low-level-developer-guides-flounder
+ git_name: apps/agl-service-can-low-level
+ path: docs/api-services-book.yml
+ dst_prefix: signaling
+-
+ id: app-afb-test-developer-guides-flounder
+ git_name: apps/app-afb-test
+ path: docs/api-services-book.yml
+ dst_prefix: afb-test
+-
+ id: high-level-developer-guides-flounder
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: iotbzh/high-level-viwi-service
+ git_commit: master
+ path: docs/api-services-book.yml
+ dst_prefix: signaling
+-
+ id: agl-service-signal-composer-developer-guides-flounder
+ git_name: apps/agl-service-signal-composer
+ path: docs/api-services-book.yml
+-
+ id: candevstudio-developer-guides-flounder
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: iotbzh/agl-documentation
+ git_commit: master
+ path: candevstudio/docs/api-services-book.yml
+ dst_prefix: candevstudio
+-
+ id: app-framework-developer-guides-flounder
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: sandbox/benierc/newdocs
+ path: docs/app-framework-book.yml
+ dst_prefix: af-binder
+-
+ id: signaling-developer-guides-flounder
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: sandbox/benierc/newdocs
+ path: docs/signaling-book.yml
+ src_prefix: docs/signaling
+# FIXME
+# -
+# id: devel-guidelines-2016-flounder
+# url_fetch: https://iot.bzh/download/public/2016/%source%
+# dst_prefix: iotbzh2016
+# documents:
+# - source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+# - source: signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+-
+ id: audio-developer-guides-flounder
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: sandbox/benierc/newdocs
+ path: docs/audio-book.yml
+ dst_prefix: audio
+-
+ id: agl-service-audio-4a-developer-guides-flounder
+ git_name: apps/agl-service-audio-4a
+ path: docs/api-services-book.yml
+ dst_prefix: audio
+-
+ id: pulseaudio-module-4a-developer-guides-flounder
+ git_name: src/pulseaudio-module-4a
+ path: api-services-book.yml
+ dst_prefix: audio
+-
+ id: agl-service-homescreen-developer-guides-flounder
+ git_name: apps/agl-service-homescreen
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+-
+ id: agl-service-windowmanager-developer-guides-flounder
+ git_name: apps/agl-service-windowmanager
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+-
+ id: agl-service-soundmanager-developer-guides-flounder
+ git_name: apps/agl-service-soundmanager
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+-
+ id: homescreen-developer-guides-flounder
+ git_name: apps/homescreen
+ path: homescreen/docs/api-services-book.yml
+ dst_prefix: hmi-framework
diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
index ae56813..d2e3813 100644
--- a/content/tocs/apis_services/section_master.yml
+++ b/content/tocs/apis_services/section_master.yml
@@ -19,12 +19,11 @@ books:
git_name: apps/agl-service-can-low-level
path: docs/api-services-book.yml
dst_prefix: signaling
-# FIXME
-#-
-# id: app-afb-test-developer-guides
-# git_name: apps/app-afb-test
-# path: docs/api-services-book.yml
-# dst_prefix: afb-test
+-
+ id: app-afb-test-developer-guides
+ git_name: apps/app-afb-test
+ path: docs/api-services-book.yml
+ dst_prefix: afb-test
-
id: high-level-developer-guides
url_fetch: GITHUB_FETCH
--
cgit
From 610dfcdc46963cdf91a6413126dd82a7071cd220 Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Wed, 13 Feb 2019 17:38:56 +0100
Subject: apis_service/section_master: fix errors
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/section_master.yml | 133 +++++++++++++-------------
1 file changed, 67 insertions(+), 66 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
index d2e3813..10cb3f6 100644
--- a/content/tocs/apis_services/section_master.yml
+++ b/content/tocs/apis_services/section_master.yml
@@ -14,91 +14,92 @@ books:
git_name: src/app-framework-binder
path: docs/api-services-book.yml
dst_prefix: af-binder
--
- id: agl-service-can-low-level-developer-guides
- git_name: apps/agl-service-can-low-level
- path: docs/api-services-book.yml
- dst_prefix: signaling
-
id: app-afb-test-developer-guides
git_name: apps/app-afb-test
path: docs/api-services-book.yml
dst_prefix: afb-test
-
- id: high-level-developer-guides
+ id: docs-source-signaling
url_fetch: GITHUB_FETCH
url_edit: GITHUB_EDIT
- git_name: iotbzh/high-level-viwi-service
- path: docs/api-services-book.yml
+ git_name: docs-source
+ path: docs/signaling-book.yml
dst_prefix: signaling
+ books:
+ - id: agl-service-can-low-level-developer-guides
+ git_name: apps/agl-service-can-low-level
+ path: docs/api-services-book.yml
+ dst_prefix: signaling
+ - id: high-level-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: iotbzh/high-level-viwi-service
+ path: docs/api-services-book.yml
+ dst_prefix: signaling
+ - id: agl-service-signal-composer-developer-guides
+ git_name: apps/agl-service-signal-composer
+ path: docs/api-services-book.yml
+ - id: devel-appfw-guidelines-2016
+ path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ dst_prefix: iotbzh2016
+ name: Developer Guidelines
+ - id: devel-message-guidelines-2016
+ path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+ dst_prefix: iotbzh2016
+ name: CAN Signaling Benchmark
+ - id: candevstudio-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: iotbzh/agl-documentation
+ path: candevstudio/docs/api-services-book.yml
+ dst_prefix: candevstudio
+ - id: app-framework-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: sandbox/benierc/newdocs
+ path: docs/app-framework-book.yml
+ dst_prefix: af-binder
-
- id: agl-service-signal-composer-developer-guides
- git_name: apps/agl-service-signal-composer
- path: docs/api-services-book.yml
--
- id: candevstudio-developer-guides
- url_fetch: GITHUB_FETCH
- url_edit: GITHUB_EDIT
- git_name: iotbzh/agl-documentation
- path: candevstudio/docs/api-services-book.yml
- dst_prefix: candevstudio
--
- id: app-framework-developer-guides
- url_fetch: GITHUB_FETCH
- url_edit: AGL_GITHUB_EDIT
- git_name: automotive-grade-linux/docs-sources
- git_commit: sandbox/benierc/newdocs
- path: docs/app-framework-book.yml
- dst_prefix: af-binder
--
- id: signaling-developer-guides
+ id: audio-developer-guides
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
git_name: automotive-grade-linux/docs-sources
git_commit: sandbox/benierc/newdocs
- path: docs/signaling-book.yml
- src_prefix: docs/signaling
-# FIXME
-# -
-# id: devel-guidelines-2016
-# url_fetch: https://iot.bzh/download/public/2016/%source%
-# dst_prefix: iotbzh2016
-# documents:
-# - source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
-# - source: signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
--
- id: audio-developer-guides
+ path: docs/audio-book.yml
+ dst_prefix: audio
+ books:
+ - id: pulseaudio-module-4a-developer-guides
+ git_name: src/pulseaudio-module-4a
+ path: api-services-book.yml
+ dst_prefix: audio
+ - id: agl-service-audio-4a-developer-guides
+ git_name: apps/agl-service-audio-4a
+ path: docs/api-services-book.yml
+ dst_prefix: audio
+-
+ id: hmi-framework
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
git_name: automotive-grade-linux/docs-sources
git_commit: sandbox/benierc/newdocs
- path: docs/audio-book.yml
- dst_prefix: audio
--
- id: agl-service-audio-4a-developer-guides
- git_name: apps/agl-service-audio-4a
- path: docs/api-services-book.yml
- dst_prefix: audio
--
- id: pulseaudio-module-4a-developer-guides
- git_name: src/pulseaudio-module-4a
- path: api-services-book.yml
- dst_prefix: audio
--
- id: agl-service-homescreen-developer-guides
- git_name: apps/agl-service-homescreen
- path: doc/api-services-book.yml
- dst_prefix: hmi-framework
--
- id: agl-service-windowmanager-developer-guides
- git_name: apps/agl-service-windowmanager
- path: doc/api-services-book.yml
- dst_prefix: hmi-framework
--
- id: agl-service-soundmanager-developer-guides
- git_name: apps/agl-service-soundmanager
- path: doc/api-services-book.yml
+ path: docs/hmi-framework-book.yml
dst_prefix: hmi-framework
+ books:
+ - id: agl-service-homescreen-developer-guides
+ name: HMI Framework
+ git_name: apps/agl-service-homescreen
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+ - id: agl-service-windowmanager-developer-guides
+ git_name: apps/agl-service-windowmanager
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+ - id: agl-service-soundmanager-developer-guides
+ git_name: apps/agl-service-soundmanager
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
-
id: homescreen-developer-guides
git_name: apps/homescreen
--
cgit
From a71578904d396e8fd6319703b93ed33d1a29239d Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Sun, 24 Feb 2019 14:42:09 +0100
Subject: section_master: switch to master
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/section_master.yml | 10 +++-------
1 file changed, 3 insertions(+), 7 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
index 10cb3f6..e137e21 100644
--- a/content/tocs/apis_services/section_master.yml
+++ b/content/tocs/apis_services/section_master.yml
@@ -1,5 +1,4 @@
url_fetch : "GERRIT_FETCH"
-git_commit : "AGL_GERRIT_BRANCH"
name: APIs & Services
template: generated_index.html
@@ -21,9 +20,9 @@ books:
dst_prefix: afb-test
-
id: docs-source-signaling
- url_fetch: GITHUB_FETCH
- url_edit: GITHUB_EDIT
- git_name: docs-source
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
path: docs/signaling-book.yml
dst_prefix: signaling
books:
@@ -58,7 +57,6 @@ books:
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
git_name: automotive-grade-linux/docs-sources
- git_commit: sandbox/benierc/newdocs
path: docs/app-framework-book.yml
dst_prefix: af-binder
-
@@ -66,7 +64,6 @@ books:
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
git_name: automotive-grade-linux/docs-sources
- git_commit: sandbox/benierc/newdocs
path: docs/audio-book.yml
dst_prefix: audio
books:
@@ -83,7 +80,6 @@ books:
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
git_name: automotive-grade-linux/docs-sources
- git_commit: sandbox/benierc/newdocs
path: docs/hmi-framework-book.yml
dst_prefix: hmi-framework
books:
--
cgit
From 46c7f782edc47fc3bb58b149ec1e0c4a37fa7d66 Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Sun, 24 Feb 2019 16:46:22 +0100
Subject: section_flouder apiservices: updated
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/section_flounder.yml | 154 ++++++++++++------------
1 file changed, 76 insertions(+), 78 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml
index ceb1912..c365671 100644
--- a/content/tocs/apis_services/section_flounder.yml
+++ b/content/tocs/apis_services/section_flounder.yml
@@ -1,108 +1,106 @@
url_fetch : "GERRIT_FETCH"
-git_commit : "flounder"
+git_commit : flounder
name: APIs & Services
template: generated_index.html
books:
-
- id: app-framework-main-developer-guides-flounder
+ id: flounder-app-framework-main-developer-guides
git_name: src/app-framework-main
path: docs/api-services-book.yml
dst_prefix: af-main
-
- id: app-framework-binder-developer-guides-flounder
+ id: flounder-app-framework-binder-developer-guides
git_name: src/app-framework-binder
path: docs/api-services-book.yml
dst_prefix: af-binder
-
- id: agl-service-can-low-level-developer-guides-flounder
- git_name: apps/agl-service-can-low-level
- path: docs/api-services-book.yml
- dst_prefix: signaling
--
- id: app-afb-test-developer-guides-flounder
+ id: flounder-app-afb-test-developer-guides
git_name: apps/app-afb-test
path: docs/api-services-book.yml
dst_prefix: afb-test
-
- id: high-level-developer-guides-flounder
- url_fetch: GITHUB_FETCH
- url_edit: GITHUB_EDIT
- git_name: iotbzh/high-level-viwi-service
- git_commit: master
- path: docs/api-services-book.yml
- dst_prefix: signaling
--
- id: agl-service-signal-composer-developer-guides-flounder
- git_name: apps/agl-service-signal-composer
- path: docs/api-services-book.yml
--
- id: candevstudio-developer-guides-flounder
- url_fetch: GITHUB_FETCH
- url_edit: GITHUB_EDIT
- git_name: iotbzh/agl-documentation
- git_commit: master
- path: candevstudio/docs/api-services-book.yml
- dst_prefix: candevstudio
--
- id: app-framework-developer-guides-flounder
- url_fetch: GITHUB_FETCH
- url_edit: AGL_GITHUB_EDIT
- git_name: automotive-grade-linux/docs-sources
- git_commit: sandbox/benierc/newdocs
- path: docs/app-framework-book.yml
- dst_prefix: af-binder
--
- id: signaling-developer-guides-flounder
- url_fetch: GITHUB_FETCH
+ id: flounder-docs-source-signaling
+ url_fetch: AGL_GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
git_name: automotive-grade-linux/docs-sources
- git_commit: sandbox/benierc/newdocs
path: docs/signaling-book.yml
- src_prefix: docs/signaling
-# FIXME
-# -
-# id: devel-guidelines-2016-flounder
-# url_fetch: https://iot.bzh/download/public/2016/%source%
-# dst_prefix: iotbzh2016
-# documents:
-# - source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
-# - source: signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
--
- id: audio-developer-guides-flounder
+ dst_prefix: signaling
+ books:
+ - id: flounder-agl-service-can-low-level-developer-guides
+ git_name: apps/agl-service-can-low-level
+ path: docs/api-services-book.yml
+ dst_prefix: signaling
+ - id: flounder-high-level-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_commit: master
+ git_name: iotbzh/high-level-viwi-service
+ path: docs/api-services-book.yml
+ dst_prefix: signaling
+ - id: flounder-agl-service-signal-composer-developer-guides
+ git_name: apps/agl-service-signal-composer
+ path: docs/api-services-book.yml
+ - id: flounder-devel-appfw-guidelines-2016
+ path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ dst_prefix: iotbzh2016
+ name: Developer Guidelines
+ - id: flounder-devel-message-guidelines-2016
+ path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+ dst_prefix: iotbzh2016
+ name: CAN Signaling Benchmark
+ - id: flounder-candevstudio-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_commit: master
+ git_name: iotbzh/agl-documentation
+ path: candevstudio/docs/api-services-book.yml
+ dst_prefix: candevstudio
+ - id: flounder-app-framework-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/app-framework-book.yml
+ dst_prefix: af-binder
+-
+ id: flounder-audio-developer-guides
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
git_name: automotive-grade-linux/docs-sources
- git_commit: sandbox/benierc/newdocs
path: docs/audio-book.yml
dst_prefix: audio
--
- id: agl-service-audio-4a-developer-guides-flounder
- git_name: apps/agl-service-audio-4a
- path: docs/api-services-book.yml
- dst_prefix: audio
--
- id: pulseaudio-module-4a-developer-guides-flounder
- git_name: src/pulseaudio-module-4a
- path: api-services-book.yml
- dst_prefix: audio
--
- id: agl-service-homescreen-developer-guides-flounder
- git_name: apps/agl-service-homescreen
- path: doc/api-services-book.yml
- dst_prefix: hmi-framework
--
- id: agl-service-windowmanager-developer-guides-flounder
- git_name: apps/agl-service-windowmanager
- path: doc/api-services-book.yml
- dst_prefix: hmi-framework
--
- id: agl-service-soundmanager-developer-guides-flounder
- git_name: apps/agl-service-soundmanager
- path: doc/api-services-book.yml
+ books:
+ - id: flounder-pulseaudio-module-4a-developer-guides
+ git_name: src/pulseaudio-module-4a
+ path: api-services-book.yml
+ dst_prefix: audio
+ - id: flounder-agl-service-audio-4a-developer-guides
+ git_name: apps/agl-service-audio-4a
+ path: docs/api-services-book.yml
+ dst_prefix: audio
+-
+ id: flounder-hmi-framework
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/hmi-framework-book.yml
dst_prefix: hmi-framework
--
- id: homescreen-developer-guides-flounder
+ books:
+ - id: flounder-agl-service-homescreen-developer-guides
+ name: HMI Framework
+ git_name: apps/agl-service-homescreen
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+ - id: flounder-agl-service-windowmanager-developer-guides
+ git_name: apps/agl-service-windowmanager
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+ - id: flounder-agl-service-soundmanager-developer-guides
+ git_name: apps/agl-service-soundmanager
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+-
+ id: flounder-homescreen-developer-guides
git_name: apps/homescreen
path: homescreen/docs/api-services-book.yml
dst_prefix: hmi-framework
--
cgit
From b6b48a138a5100190f33a71a526f774b94514315 Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Sun, 24 Feb 2019 19:21:40 +0100
Subject: add guppy sections
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/section_guppy.yml | 109 +++++++++++++++++++++++++++
1 file changed, 109 insertions(+)
create mode 100644 content/tocs/apis_services/section_guppy.yml
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_guppy.yml b/content/tocs/apis_services/section_guppy.yml
new file mode 100644
index 0000000..d339eb1
--- /dev/null
+++ b/content/tocs/apis_services/section_guppy.yml
@@ -0,0 +1,109 @@
+url_fetch : "GERRIT_FETCH"
+
+name: APIs & Services
+template: generated_index.html
+books:
+-
+ id: app-framework-main-developer-guides
+ git_name: src/app-framework-main
+ path: docs/api-services-book.yml
+ dst_prefix: af-main
+-
+ id: app-framework-binder-developer-guides
+ git_name: src/app-framework-binder
+ path: docs/api-services-book.yml
+ dst_prefix: af-binder
+-
+ id: app-afb-test-developer-guides
+ git_name: apps/app-afb-test
+ path: docs/api-services-book.yml
+ dst_prefix: afb-test
+-
+ id: docs-source-signaling
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_commit: master
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/signaling-book.yml
+ dst_prefix: signaling
+ books:
+ - id: agl-service-can-low-level-developer-guides
+ git_name: apps/agl-service-can-low-level
+ path: docs/api-services-book.yml
+ dst_prefix: signaling
+ - id: high-level-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_commit: master
+ git_name: iotbzh/high-level-viwi-service
+ path: docs/api-services-book.yml
+ dst_prefix: signaling
+ - id: agl-service-signal-composer-developer-guides
+ git_name: apps/agl-service-signal-composer
+ path: docs/api-services-book.yml
+ - id: devel-appfw-guidelines-2016
+ path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ dst_prefix: iotbzh2016
+ name: Developer Guidelines
+ - id: devel-message-guidelines-2016
+ path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+ dst_prefix: iotbzh2016
+ name: CAN Signaling Benchmark
+ - id: candevstudio-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_commit: master
+ git_name: iotbzh/agl-documentation
+ path: candevstudio/docs/api-services-book.yml
+ dst_prefix: candevstudio
+ - id: app-framework-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_commit: master
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/app-framework-book.yml
+ dst_prefix: af-binder
+-
+ id: audio-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_commit: master
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/audio-book.yml
+ dst_prefix: audio
+ books:
+ - id: pulseaudio-module-4a-developer-guides
+ git_name: src/pulseaudio-module-4a
+ path: api-services-book.yml
+ dst_prefix: audio
+ - id: agl-service-audio-4a-developer-guides
+ git_name: apps/agl-service-audio-4a
+ path: docs/api-services-book.yml
+ dst_prefix: audio
+-
+ id: hmi-framework
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_commit: master
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/hmi-framework-book.yml
+ dst_prefix: hmi-framework
+ books:
+ - id: agl-service-homescreen-developer-guides
+ name: HMI Framework
+ git_name: apps/agl-service-homescreen
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+ - id: agl-service-windowmanager-developer-guides
+ git_name: apps/agl-service-windowmanager
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+ - id: agl-service-soundmanager-developer-guides
+ git_name: apps/agl-service-soundmanager
+ path: doc/api-services-book.yml
+ dst_prefix: hmi-framework
+-
+ id: homescreen-developer-guides
+ git_name: apps/homescreen
+ path: homescreen/docs/api-services-book.yml
+ dst_prefix: hmi-framework
--
cgit
From c0fafcb577abb8108490540f7ecfe949a92c7fd0 Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Sun, 24 Feb 2019 20:05:22 +0100
Subject: reset tocs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/fetched_files.yml | 420 +++++++++++++++++++++++++++
content/tocs/apis_services/toc_dev_en.yml | 181 ++++++++++++
2 files changed, 601 insertions(+)
create mode 100644 content/tocs/apis_services/fetched_files.yml
create mode 100644 content/tocs/apis_services/toc_dev_en.yml
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml
new file mode 100644
index 0000000..f1709a0
--- /dev/null
+++ b/content/tocs/apis_services/fetched_files.yml
@@ -0,0 +1,420 @@
+##############################################################################################################
+# GLOBAL DOCUMENT
+# <any REPOSITORY option>: global setting
+# repositories: array of objects with documents to fetchd
+#
+# REPOSITORY ENTRY:
+# -
+# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
+# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
+# git_name: repository name (%repo%)
+# git_commit: git reference: revision, SHA1, branch... (%commit%)
+# src_prefix: prefix prepended to %source%
+# dst_prefix: prefix prepended to destination name
+# documents: array of documents to fetch
+#
+# DOCUMENT ENTRY:
+# source: subpath within repository (%source%)
+# destination: local destination filename
+# label|title: name within TOC
+# edit|editURI: specific edition URI
+#
+# EXAMPLE:
+# ------------------------------------
+# url: "GERRIT_FETCH"
+# git_commit: "master"
+# repositories:
+# -
+# git_name: src/foo
+# src_prefix: docs
+# dst_prefix: foodocs
+# documents:
+# - source: intro.md
+# label: Introduction
+# - source: topic/README.md
+# destination: topic.md
+# label: My Topic
+# ------------------------------------
+##############################################################################################################
+
+url_fetch: GERRIT_FETCH
+git_commit: AGL_GERRIT_BRANCH
+
+repositories:
+-
+ git_name: src/app-framework-main
+ src_prefix: docs
+ dst_prefix: af-main
+ documents:
+ - source: 0-introduction.md
+ label: Introduction
+ - source: 0-kristi-introduction.md
+ label: API Reference
+ - source: 1-afm-daemons.md
+ label: The afm daemons
+ - source: 2-widgets.md
+ label: Widgets
+ - source: 2.1-widgets.md
+ label: Overview of widgets
+ - source: 2.2-config.xml.md
+ label: Widget configuration file
+ - source: 3-permissions.md
+ label: Permissions
+ - source: 4-quick-tutorial.md
+ label: Quick Tutorial
+ - source: pictures/afm-daemons.svg
+ - source: pictures/AppFW-APP_install_sequences.svg
+ - source: pictures/make-units.svg
+ - source: pictures/Security_model_history.svg
+ - source: pictures/triskel_iot_bzh.svg
+
+-
+ git_name: src/app-framework-binder
+ src_prefix: docs
+ dst_prefix: af-binder
+ documents:
+ - source: index.md
+ label: Binder index
+ - source: afb-overview.md
+ label: Overview
+ - source: afb-binding-writing.md
+ label: How to write a binding ?
+ - source: afb-binding-references.md
+ label: Binding references
+ - source: reference-v3/types-and-globals.md
+ label: Types and globals
+ - source: reference-v3/func-api.md
+ label: Functions of class afb_api
+ - source: reference-v3/func-req.md
+ label: Functions of class afb_req
+ - source: reference-v3/func-event.md
+ label: Functions of class afb_event
+ - source: reference-v3/func-daemon.md
+ label: Functions of class afb_daemon
+ - source: reference-v3/func-service.md
+ label: Functions of class afb_service
+ - source: reference-v3/macro-log.md
+ label: Macros for logging
+ - source: afb-migration-to-binding-v3.md
+ label: Migration to bindings v3
+ - source: afb-events-guide.md
+ label: Binder events guide
+ - source: afb-application-writing.md
+ label: Binder Application writing guide
+ - source: afb-daemon-vocabulary.md
+ label: Binder daemon vocabulary
+ - source: afb-desktop-package.md
+ label: Installing the binder on a desktop
+ - source: afb-daemon-debugging.md
+ label: Debugging binder and bindings
+ - source: afb-daemon-options.md
+ label: Options of afb-daemon
+ - source: protocol-x-afb-ws-json1.md
+ label: WebSocket protocol x-afb-ws-json1
+ - source: annexes.md
+ label: Annexes
+ - source: REVISIONS.md
+ label: Document revision
+ - source: legacy/afb-migration-v1-to-v2.md
+ label: LEGACY Migration from v1 to v2
+ - source: legacy/afb-binding-v2-references.md
+ label: LEGACY Binding V2 references
+ - source: pictures/AFB_for_services.svg
+ - source: pictures/basis.svg
+ - source: pictures/interconnection.svg
+ - source: pictures/signaling-basis.svg
+ - source: pictures/tic-tac-toe.svg
+ - source: pictures/triskel_iot_bzh.svg
+
+-
+ git_name: apps/agl-service-can-low-level
+ src_prefix: docs
+ dst_prefix: signaling
+ documents:
+ - source: 1-Architecture.md
+ destination: low-can-architecture.md
+ label: Architecture presentation
+ - source: 2-Installation.md
+ destination: low-can-installation-guide.md
+ label: Installation Guide
+ - source: 3-Usage.md
+ destination: low-can-usage-guide.md
+ label: Usage Guide
+ - source: images/CAN_bindings_communication.png
+ - source: images/CAN_level_mapping.png
+ - source: images/OpenXC_to_AGL.png
+
+-
+ git_name: apps/app-afb-test
+ src_prefix: docs
+ dst_prefix: afb-test
+ documents:
+ - source: 0_Installation.md
+ destination: Installation.md
+ label: Installation
+ - source: 1_Write_the_tests.md
+ destination: write-the-tests.md
+ label: Write the tests
+ - source: 2_The_test_widget.md
+ destination: the-test-widget.md
+ label: The test widget
+ - source: 3_Launch_the_tests.md
+ destination: launch-the-tests.md
+ label: Launch the tests
+ - source: 4_Tests_Examples.md
+ destination: tests-examples.md
+ label: Tests examples
+ - source: Reference/0_BindingTestFunctions.md
+ destination: binding-test-functions.md
+ label: Binding Test Functions
+ - source: Reference/1_BindingAssertFunctions.md
+ destination: binding-assert-functions.md
+ label: Binding Assert Functions
+ - source: Reference/2_TestFrameworkFunctions.md
+ destination: test-framework-functions.md
+ label: Test Framework Functions
+ - source: Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md
+ destination: general-assertions.md
+ label: General Assertions
+ - source: Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md
+ destination: value-assertions.md
+ label: Value Assertions
+ - source: Reference/LuaUnitAssertionFunctions/2_ScientificAssertions.md
+ destination: scientific-assertions.md
+ label: Scientific Assertions
+ - source: Reference/LuaUnitAssertionFunctions/3_StringAssertions.md
+ destination: string-assertions.md
+ label: String Assertions
+ - source: Reference/LuaUnitAssertionFunctions/4_ErrorAssertions.md
+ destination: error-assertions.md
+ label: Error Assertions
+ - source: Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md
+ destination: type-assertions.md
+ label: Type Assertions
+ - source: Reference/LuaUnitAssertionFunctions/6_TableAssertions.md
+ destination: table-assertions.md
+ label: Table Assertions
+
+-
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: iotbzh/high-level-viwi-service
+ git_commit: master
+ src_prefix: docs
+ dst_prefix: signaling
+ documents:
+ - source: 1-Architecture.md
+ destination: high-viwi-architecture.md
+ label: Architecture presentation
+ - source: 2-Install-Usage.md
+ destination: high-viwi-install-usage-guide.md
+ label: Installation and Usage Guide
+ - source: images/high-level-arch.png
+-
+ git_name: apps/agl-service-signal-composer
+ src_prefix: docs/part-1/
+ dst_prefix: signaling
+ documents:
+ - source: 1-Architecture.md
+ destination: signal-composer-architecture.md
+ label: Architecture presentation
+ - source: 2-Configuration.md
+ destination: signal-composer-configuration.md
+ label: Configuration
+ - source: 3-Plugins.md
+ destination: signal-composer-plugins.md
+ label: Plugins
+ - source: 4-SignalComposerAPI.md
+ destination: signal-composer-api.md
+ label: Signal Composer API
+ - source: pictures/Global_Signaling_Architecture.png
+ - source: pictures/iotbzh_logo_small.png
+-
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: iotbzh/agl-documentation
+ git_commit: master
+ documents:
+ - source: candevstudio/docs/1_Usage.md
+ - source: candevstudio/docs/2_can_device_socketcan_backend.md
+ - source: candevstudio/docs/3_Add_CAN_Device.md
+ - source: candevstudio/docs/4_Configure_CanRawSender_Node.md
+ - source: candevstudio/docs/5_Using_CanRawView.md
+ - source: candevstudio/docs/pictures/CANdevStudio.png
+ - source: candevstudio/docs/pictures/canrawsender.png
+ - source: candevstudio/docs/pictures/canrawviewer.png
+
+-
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: AGL_GITHUB_BRANCH
+ src_prefix: docs/app-framework
+ dst_prefix: af-binder
+ documents:
+ - source: index.md
+ destination: resources.md
+ label: Resources
+-
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: AGL_GITHUB_BRANCH
+ src_prefix: docs/signaling
+ dst_prefix: signaling
+ documents:
+ - source: architecture.md
+ destination: architecture.md
+ label: Signaling Architecture
+ - source: index.md
+ destination: resources.md
+ label: Resources
+ - source: images/agent-arch.svg
+ - source: images/agent-sample.svg
+ - source: images/cloud-arch.svg
+ - source: images/can-generator.svg
+ - source: images/distributed-arch.svg
+ - source: images/distributed-arch.png
+ - source: images/signal-service-arch.svg
+-
+ url_fetch: https://iot.bzh/download/public/2016/%source%
+ dst_prefix: iotbzh2016
+ documents:
+ - source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ - source: signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+-
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: AGL_GITHUB_BRANCH
+ src_prefix: docs/audio
+ dst_prefix: audio
+ documents:
+ - source: 4a-framework.md
+ destination: 4a-framework.md
+ label: 4a-framework
+ - source: bluez-alsa.md
+ destination: bluez-alsa.md
+ label: bluez-alsa
+-
+ git_name: apps/agl-service-audio-4a
+ src_prefix: docs
+ dst_prefix: audio
+ documents:
+ - source: 4a-framework/README.md
+ label: Architecture
+ - source: 4a-framework/concepts.md
+ label: Concepts
+ - source: 4a-framework/components.md
+ label: Components
+ - source: 4a-framework/images/4a-architecture.svg
+ - source: 4a-framework/images/apps-architecture.svg
+ - source: 4a-framework/images/agl-audio-arch.png
+ - source: high-level-api/README.md
+ label: Abstract
+ - source: high-level-api/kickstart.md
+ label: Kickstart
+ - source: high-level-api/reference.md
+ label: Reference
+ - source: high-level-api/TipsAndTricks/AdjustVolumes.md
+ label: Adjust volumes
+ - source: high-level-api/TipsAndTricks/4aTools.md
+ label: 4a-tools
+ - source: high-level-api/TipsAndTricks/Devices.md
+ label: Devices
+ - source: high-level-api/TipsAndTricks/HALs.md
+ label: HALs
+ - source: high-level-api/TipsAndTricks/images/changeSound.png
+ - source: high-level-api/TipsAndTricks/images/MixerBaseMenu.png
+-
+ git_name: src/pulseaudio-module-4a
+ dst_prefix: audio
+ documents:
+ - source: README.md
+ destination: pulseaudio-module-4a.md
+ label: Pulseaudio - 4A Integration Module
+-
+ git_name: apps/agl-service-homescreen
+ src_prefix: doc/
+ dst_prefix: hmi-framework/
+ documents:
+ - source: ApplicationGuide.md
+ destination: 3_1-HomeScreen-Guide.md
+ label: Home Screen Developper Guide
+ - source: parts/software-stack.png
+ - source: parts/initialize-set-event-handler.svg
+ - source: parts/tap_shortcut.svg
+ - source: parts/showWindow.svg
+ - source: parts/on_screen_message.svg
+ - source: parts/showOnScreen.svg
+ - source: parts/showNotification.svg
+ - source: parts/showInformation.svg
+-
+ git_name: apps/agl-service-windowmanager
+ src_prefix: doc/
+ dst_prefix: hmi-framework/
+ documents:
+ - source: ApplicationGuide.md
+ destination: 3_2-WindowManager-Guide.md
+ label: Window Manager Developper Guide
+ - source: parts/state_change_example.png
+ - source: parts/wm_software_stack.png
+ - source: parts/wm_layer_stack.png
+ - source: parts/wm_area.png
+ - source: parts/request_role.png
+ - source: parts/hmi_framework_designed_seq_toyota.png
+ - source: parts/deactivate_window.png
+ - source: parts/example_split.png
+-
+ git_name: apps/agl-service-soundmanager
+ src_prefix: doc/
+ dst_prefix: hmi-framework/
+ documents:
+ - source: ApplicationGuide.md
+ destination: 3_3-SoundManager-Guide.md
+ label: Sound Manager Developper Guide
+ - source: Display_Audio_Transition1.md
+ destination: Display_Audio_Transition1.md
+ label: Sound Manager Developper Guide 2
+ - source: Display_Audio_Transition2.md
+ destination: Display_Audio_Transition2.md
+ label: Sound Manager Developper Guide 3
+ - source: parts/seq_startup.svg
+ - source: parts/am-component.png
+ - source: parts/seq_registration.svg
+ - source: parts/seq_connectsoundroute.svg
+ - source: parts/seq_startsoundstreaming.svg
+ - source: parts/seq_requestsoundmode.svg
+ - source: parts/seq_setmutestate.svg
+ - source: parts/seq_changevolume.svg
+ - source: parts/seq_stopsoundstreaming.svg
+ - source: parts/seq_disconnectsoundroute.svg
+ - source: parts/software-stack.png
+ - source: parts/seq_releasesoundmode.svg
+ - source: parts/typical-usecase.png
+ - source: parts/am-component.png
+-
+ git_name: apps/homescreen
+ src_prefix: homescreen/docs
+ dst_prefix: homescreen
+ documents:
+ - source: homescreen_api.md
+ label: HomeScreen API
+ - source: pictures/api_getAllSurfacesOfProcess.png
+ destination: pictures/api_getAllSurfacesOfProcess.png
+ - source: pictures/api_getSurfaceStatus_1.png
+ destination: pictures/api_getSurfaceStatus_1.png
+ - source: pictures/api_getSurfaceStatus_2.png
+ destination: pictures/api_getSurfaceStatus_2.png
+ - source: pictures/api_getSurfaceStatus_3.png
+ destination: pictures/api_getSurfaceStatus_3.png
+ - source: pictures/api_hardKeyPressed.png
+ destination: pictures/api_hardKeyPressed.png
+ - source: pictures/api_renderSurfaceToArea.png
+ destination: pictures/api_renderSurfaceToArea.png
+ - source: pictures/api_renderSurfaceToAreaAllowed.png
+ destination: pictures/api_renderSurfaceToAreaAllowed.png
+ - source: pictures/api_requestSurfaceIdToFullScreen.png
+ destination: pictures/api_requestSurfaceIdToFullScreen.png
+ - source: pictures/api_surfaceVisibilityChanged.png
+ destination: pictures/api_surfaceVisibilityChanged.png
diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml
new file mode 100644
index 0000000..023e699
--- /dev/null
+++ b/content/tocs/apis_services/toc_dev_en.yml
@@ -0,0 +1,181 @@
+#######################################################################
+# WARNING:
+# - TOC should reference .HTML and .md (Index OK but Error 404)
+# - do not forget to run 'docbuild --tocs' after any changes
+#
+#
+############################ SYNTAX ###################################
+# GLOBAL OPTIONS:
+# name: TOC (page) title
+# template: name of template to use for this page - use 'generated_index.html' if unknown
+# children: array of TOC entries
+#
+# TOC Entry:
+# name: TOC entry (level 1)
+# children:
+# -
+# name: optional name for TOC entry (default: use URL FrontMatter info)
+# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js:
+# -
+# name: ...
+# url: ...
+# ...
+#
+# EXAMPLE:
+# -------------------------------
+# name: Developer Guides
+# template: generated_index.html
+# children:
+# -
+# name: Application Framework
+# children:
+# - url: reference/af-main/overview.html
+# - url: reference/af-main/afm-system-daemon.html
+# - url: reference/af-main/afm-user-daemon.html
+# -------------------------------
+#######################################################################
+
+name: Developer Guides
+template: generated_index.html
+children:
+-
+ name: API Reference
+ children:
+ - url: reference/af-main/0-kristi-introduction.html
+
+-
+ name: Application Framework
+ children:
+ - url: reference/af-main/0-introduction.html
+ - url: reference/af-main/1-afm-daemons.html
+ - url: reference/af-main/2-widgets.html
+ - url: reference/af-main/2.1-widgets.html
+ - url: reference/af-main/2.2-config.xml.html
+ - url: reference/af-main/3-permissions.html
+ - url: reference/af-main/4-quick-tutorial.html
+-
+ name: Application Framework Binder
+ children:
+ - url: reference/af-binder/afb-overview.html
+ - url: reference/af-binder/afb-daemon-vocabulary.html
+ - url: reference/af-binder/afb-binding-writing.html
+ - name: Binder references
+ children:
+ - url: reference/af-binder/reference-v3/types-and-globals.html
+ - url: reference/af-binder/reference-v3/macro-log.html
+ - url: reference/af-binder/reference-v3/func-api.html
+ - url: reference/af-binder/reference-v3/func-req.html
+ - url: reference/af-binder/reference-v3/func-event.html
+ - url: reference/af-binder/reference-v3/func-daemon.html
+ - url: reference/af-binder/reference-v3/func-service.html
+ - url: reference/af-binder/afb-events-guide.html
+ - url: reference/af-binder/afb-application-writing.html
+ - name: Annexes
+ children:
+ - url: reference/af-binder/afb-migration-to-binding-v3.html
+ - url: reference/af-binder/protocol-x-afb-ws-json1.html
+ - url: reference/af-binder/afb-desktop-package.html
+ - url: reference/af-binder/afb-daemon-options.html
+ - url: reference/af-binder/afb-daemon-debugging.html
+ - url: reference/af-binder/legacy/afb-migration-v1-to-v2.html
+ - url: reference/af-binder/legacy/afb-binding-v2-references.html
+ - url: reference/af-binder/REVISIONS.html
+
+-
+ name: AGL Test Framework
+ children:
+ - url: reference/afb-test/Installation.html
+ - url: reference/afb-test/write-the-tests.html
+ - url: reference/afb-test/the-test-widget.html
+ - url: reference/afb-test/launch-the-tests.html
+ - url: reference/afb-test/tests-examples.html
+ - name: References
+ children:
+ - url: reference/afb-test/binding-test-functions.html
+ - url: reference/afb-test/binding-assert-functions.html
+ - url: reference/afb-test/test-framework-functions.html
+ - name: LuaUnit Assertion Functions
+ children:
+ - url: reference/afb-test/general-assertions.html
+ - url: reference/afb-test/value-assertions.html
+ - url: reference/afb-test/scientific-assertions.html
+ - url: reference/afb-test/string-assertions.html
+ - url: reference/afb-test/error-assertions.html
+ - url: reference/afb-test/type-assertions.html
+ - url: reference/afb-test/table-assertions.html
+
+-
+ name: Message Signaling
+ children:
+ - url: reference/signaling/architecture.html
+ - name: Low level CAN service Guide
+ children:
+ - url: reference/signaling/low-can-architecture.html
+ - url: reference/signaling/low-can-installation-guide.html
+ - url: reference/signaling/low-can-usage-guide.html
+ - name: High level ViWi service Guide
+ children:
+ - url: reference/signaling/high-viwi-architecture.html
+ - url: reference/signaling/high-viwi-install-usage-guide.html
+ - name: Signal Composer service Guide
+ children:
+ - url: reference/signaling/signal-composer-architecture.html
+ - url: reference/signaling/signal-composer-configuration.html
+ - url: reference/signaling/signal-composer-plugins.html
+ - url: reference/signaling/signal-composer-api.html
+ - name: Developer Guidelines
+ url: reference/iotbzh2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+ - name: CAN Signaling Benchmark
+ url: reference/iotbzh2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ - name: CanDevStudio Quickstart
+ children:
+ - name: Usage Guide
+ url: reference/candevstudio/docs/1_Usage.html
+ - name: Bringing up a CAN device using socketcan backend
+ url: reference/candevstudio/docs/2_can_device_socketcan_backend.html
+ - name: Add a CAN device in CANdevStudio
+ url: reference/candevstudio/docs/3_Add_CAN_Device.html
+ - name: Configure a CanRawSender node
+ url: reference/candevstudio/docs/4_Configure_CanRawSender_Node.html
+ - name: Using CanRawView
+ url: reference/candevstudio/docs/5_Using_CanRawView.html
+ - url: reference/signaling/resources.html
+-
+ name: Audio Framework
+ children:
+ - url: reference/audio/bluez-alsa.html
+ - url: reference/audio/pulseaudio-module-4a.html
+ - name: 4a Framework
+ children:
+ - url: reference/audio/4a-framework/README.html
+ - url: reference/audio/4a-framework/concepts.html
+ - url: reference/audio/4a-framework/components.html
+ - name: high-level-api
+ children:
+ - url: reference/audio/high-level-api/README.html
+ - url: reference/audio/high-level-api/kickstart.html
+ - url: reference/audio/high-level-api/reference.html
+ - name: Tips And Tricks
+ children:
+ - url: reference/audio/high-level-api/TipsAndTricks/AdjustVolumes.html
+ - url: reference/audio/high-level-api/TipsAndTricks/4aTools.html
+ - url: reference/audio/high-level-api/TipsAndTricks/Devices.html
+ - url: reference/audio/high-level-api/TipsAndTricks/HALs.html
+-
+ name: HMI Framework
+ children:
+ -
+ name: Home Screen Developper Guide
+ url: reference/hmi-framework/3_1-HomeScreen-Guide.html
+ -
+ name: Window Manager Developper Guide
+ url: reference/hmi-framework/3_2-WindowManager-Guide.html
+ -
+ name: Sound Manager Developper Guide
+ url: reference/hmi-framework/3_3-SoundManager-Guide.html
+-
+ name: HomeScreen (old)
+ children:
+ - url: reference/homescreen/homescreen_api.html
+
+
--
cgit
From 544594fc071e3a5163cc5f4352b1cee70f9983dd Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Mon, 25 Feb 2019 11:58:36 +0100
Subject: docs-source switch to master-next
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/section_flounder.yml | 4 ++++
content/tocs/apis_services/section_guppy.yml | 8 ++++----
content/tocs/apis_services/section_master.yml | 4 ++++
3 files changed, 12 insertions(+), 4 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml
index c365671..b118ab1 100644
--- a/content/tocs/apis_services/section_flounder.yml
+++ b/content/tocs/apis_services/section_flounder.yml
@@ -23,6 +23,7 @@ books:
id: flounder-docs-source-signaling
url_fetch: AGL_GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/signaling-book.yml
dst_prefix: signaling
@@ -59,6 +60,7 @@ books:
- id: flounder-app-framework-developer-guides
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/app-framework-book.yml
dst_prefix: af-binder
@@ -66,6 +68,7 @@ books:
id: flounder-audio-developer-guides
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/audio-book.yml
dst_prefix: audio
@@ -82,6 +85,7 @@ books:
id: flounder-hmi-framework
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/hmi-framework-book.yml
dst_prefix: hmi-framework
diff --git a/content/tocs/apis_services/section_guppy.yml b/content/tocs/apis_services/section_guppy.yml
index d339eb1..c8f43ee 100644
--- a/content/tocs/apis_services/section_guppy.yml
+++ b/content/tocs/apis_services/section_guppy.yml
@@ -22,7 +22,7 @@ books:
id: docs-source-signaling
url_fetch: AGL_GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
- git_commit: master
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/signaling-book.yml
dst_prefix: signaling
@@ -59,7 +59,7 @@ books:
- id: app-framework-developer-guides
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
- git_commit: master
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/app-framework-book.yml
dst_prefix: af-binder
@@ -67,7 +67,7 @@ books:
id: audio-developer-guides
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
- git_commit: master
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/audio-book.yml
dst_prefix: audio
@@ -84,7 +84,7 @@ books:
id: hmi-framework
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
- git_commit: master
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/hmi-framework-book.yml
dst_prefix: hmi-framework
diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
index e137e21..daffedf 100644
--- a/content/tocs/apis_services/section_master.yml
+++ b/content/tocs/apis_services/section_master.yml
@@ -22,6 +22,7 @@ books:
id: docs-source-signaling
url_fetch: AGL_GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/signaling-book.yml
dst_prefix: signaling
@@ -56,6 +57,7 @@ books:
- id: app-framework-developer-guides
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/app-framework-book.yml
dst_prefix: af-binder
@@ -63,6 +65,7 @@ books:
id: audio-developer-guides
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/audio-book.yml
dst_prefix: audio
@@ -79,6 +82,7 @@ books:
id: hmi-framework
url_fetch: GITHUB_FETCH
url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
git_name: automotive-grade-linux/docs-sources
path: docs/hmi-framework-book.yml
dst_prefix: hmi-framework
--
cgit
From 6f3374f0d2adbba792a7a298a8a592a476e4d69f Mon Sep 17 00:00:00 2001
From: Clément Bénier <clement.benier@iot.bzh>
Date: Mon, 11 Mar 2019 17:01:25 +0100
Subject: brotherBooks: rename appendBooks into brotherBooks
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
- add brotherBooks entry when needed
Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
---
content/tocs/apis_services/section_flounder.yml | 37 ++++++++++++---------
content/tocs/apis_services/section_guppy.yml | 43 ++++++++++++++-----------
content/tocs/apis_services/section_master.yml | 37 ++++++++++++---------
3 files changed, 66 insertions(+), 51 deletions(-)
(limited to 'content/tocs/apis_services')
diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml
index b118ab1..f9a9015 100644
--- a/content/tocs/apis_services/section_flounder.yml
+++ b/content/tocs/apis_services/section_flounder.yml
@@ -27,6 +27,25 @@ books:
git_name: automotive-grade-linux/docs-sources
path: docs/signaling-book.yml
dst_prefix: signaling
+ brotherBooks:
+ - id: flounder-devel-appfw-guidelines-2016
+ order: 60
+ path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ dst_prefix: iotbzh2016
+ name: Developer Guidelines
+ - id: flounder-devel-message-guidelines-2016
+ order: 60
+ path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+ dst_prefix: iotbzh2016
+ name: CAN Signaling Benchmark
+ - id: flounder-app-framework-developer-guides
+ order: 80
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/app-framework-book.yml
+ dst_prefix: af-binder
books:
- id: flounder-agl-service-can-low-level-developer-guides
git_name: apps/agl-service-can-low-level
@@ -42,28 +61,14 @@ books:
- id: flounder-agl-service-signal-composer-developer-guides
git_name: apps/agl-service-signal-composer
path: docs/api-services-book.yml
- - id: flounder-devel-appfw-guidelines-2016
- path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
- dst_prefix: iotbzh2016
- name: Developer Guidelines
- - id: flounder-devel-message-guidelines-2016
- path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
- dst_prefix: iotbzh2016
- name: CAN Signaling Benchmark
- id: flounder-candevstudio-developer-guides
+ order: 70
url_fetch: GITHUB_FETCH
url_edit: GITHUB_EDIT
git_commit: master
git_name: iotbzh/agl-documentation
path: candevstudio/docs/api-services-book.yml
dst_prefix: candevstudio
- - id: flounder-app-framework-developer-guides
- url_fetch: GITHUB_FETCH
- url_edit: AGL_GITHUB_EDIT
- git_commit: master-next
- git_name: automotive-grade-linux/docs-sources
- path: docs/app-framework-book.yml
- dst_prefix: af-binder
-
id: flounder-audio-developer-guides
url_fetch: GITHUB_FETCH
@@ -89,7 +94,7 @@ books:
git_name: automotive-grade-linux/docs-sources
path: docs/hmi-framework-book.yml
dst_prefix: hmi-framework
- books:
+ brotherBooks:
- id: flounder-agl-service-homescreen-developer-guides
name: HMI Framework
git_name: apps/agl-service-homescreen
diff --git a/content/tocs/apis_services/section_guppy.yml b/content/tocs/apis_services/section_guppy.yml
index c8f43ee..cce1fa1 100644
--- a/content/tocs/apis_services/section_guppy.yml
+++ b/content/tocs/apis_services/section_guppy.yml
@@ -26,6 +26,28 @@ books:
git_name: automotive-grade-linux/docs-sources
path: docs/signaling-book.yml
dst_prefix: signaling
+ brotherBooks:
+ - id: agl-service-signal-composer-developer-guides
+ order: 60
+ git_name: apps/agl-service-signal-composer
+ path: docs/api-services-book.yml
+ - id: devel-appfw-guidelines-2016
+ path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ dst_prefix: iotbzh2016
+ order: 60
+ name: Developer Guidelines
+ - id: devel-message-guidelines-2016
+ path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+ dst_prefix: iotbzh2016
+ name: CAN Signaling Benchmark
+ - id: app-framework-developer-guides
+ order: 80
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/app-framework-book.yml
+ dst_prefix: af-binder
books:
- id: agl-service-can-low-level-developer-guides
git_name: apps/agl-service-can-low-level
@@ -38,31 +60,14 @@ books:
git_name: iotbzh/high-level-viwi-service
path: docs/api-services-book.yml
dst_prefix: signaling
- - id: agl-service-signal-composer-developer-guides
- git_name: apps/agl-service-signal-composer
- path: docs/api-services-book.yml
- - id: devel-appfw-guidelines-2016
- path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
- dst_prefix: iotbzh2016
- name: Developer Guidelines
- - id: devel-message-guidelines-2016
- path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
- dst_prefix: iotbzh2016
- name: CAN Signaling Benchmark
- id: candevstudio-developer-guides
+ order: 70
url_fetch: GITHUB_FETCH
url_edit: GITHUB_EDIT
git_commit: master
git_name: iotbzh/agl-documentation
path: candevstudio/docs/api-services-book.yml
dst_prefix: candevstudio
- - id: app-framework-developer-guides
- url_fetch: GITHUB_FETCH
- url_edit: AGL_GITHUB_EDIT
- git_commit: master-next
- git_name: automotive-grade-linux/docs-sources
- path: docs/app-framework-book.yml
- dst_prefix: af-binder
-
id: audio-developer-guides
url_fetch: GITHUB_FETCH
@@ -88,7 +93,7 @@ books:
git_name: automotive-grade-linux/docs-sources
path: docs/hmi-framework-book.yml
dst_prefix: hmi-framework
- books:
+ brotherBooks:
- id: agl-service-homescreen-developer-guides
name: HMI Framework
git_name: apps/agl-service-homescreen
diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
index daffedf..273dfe8 100644
--- a/content/tocs/apis_services/section_master.yml
+++ b/content/tocs/apis_services/section_master.yml
@@ -26,6 +26,25 @@ books:
git_name: automotive-grade-linux/docs-sources
path: docs/signaling-book.yml
dst_prefix: signaling
+ brotherBooks:
+ - id: devel-appfw-guidelines-2016
+ order: 60
+ path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ dst_prefix: iotbzh2016
+ name: Developer Guidelines
+ - id: devel-message-guidelines-2016
+ order: 60
+ path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+ dst_prefix: iotbzh2016
+ name: CAN Signaling Benchmark
+ - id: app-framework-developer-guides
+ order: 80
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_commit: master-next
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/app-framework-book.yml
+ dst_prefix: af-binder
books:
- id: agl-service-can-low-level-developer-guides
git_name: apps/agl-service-can-low-level
@@ -40,27 +59,13 @@ books:
- id: agl-service-signal-composer-developer-guides
git_name: apps/agl-service-signal-composer
path: docs/api-services-book.yml
- - id: devel-appfw-guidelines-2016
- path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
- dst_prefix: iotbzh2016
- name: Developer Guidelines
- - id: devel-message-guidelines-2016
- path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
- dst_prefix: iotbzh2016
- name: CAN Signaling Benchmark
- id: candevstudio-developer-guides
+ order: 70
url_fetch: GITHUB_FETCH
url_edit: GITHUB_EDIT
git_name: iotbzh/agl-documentation
path: candevstudio/docs/api-services-book.yml
dst_prefix: candevstudio
- - id: app-framework-developer-guides
- url_fetch: GITHUB_FETCH
- url_edit: AGL_GITHUB_EDIT
- git_commit: master-next
- git_name: automotive-grade-linux/docs-sources
- path: docs/app-framework-book.yml
- dst_prefix: af-binder
-
id: audio-developer-guides
url_fetch: GITHUB_FETCH
@@ -86,7 +91,7 @@ books:
git_name: automotive-grade-linux/docs-sources
path: docs/hmi-framework-book.yml
dst_prefix: hmi-framework
- books:
+ brotherBooks:
- id: agl-service-homescreen-developer-guides
name: HMI Framework
git_name: apps/agl-service-homescreen
--
cgit