diff options
Diffstat (limited to 'content/tocs/apis_services')
-rw-r--r-- | content/tocs/apis_services/section_flounder.yml | 1 | ||||
-rw-r--r-- | content/tocs/apis_services/section_guppy.yml | 7 | ||||
-rw-r--r-- | content/tocs/apis_services/section_halibut.yml | 115 | ||||
-rw-r--r-- | content/tocs/apis_services/section_master.yml | 5 | ||||
-rw-r--r-- | content/tocs/apis_services/toc_dev_en.yml | 181 |
5 files changed, 121 insertions, 188 deletions
diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml index e2571ea..41f55da 100644 --- a/content/tocs/apis_services/section_flounder.yml +++ b/content/tocs/apis_services/section_flounder.yml @@ -58,7 +58,6 @@ books: - 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 diff --git a/content/tocs/apis_services/section_guppy.yml b/content/tocs/apis_services/section_guppy.yml index b75bbac..e07066a 100644 --- a/content/tocs/apis_services/section_guppy.yml +++ b/content/tocs/apis_services/section_guppy.yml @@ -4,6 +4,12 @@ name: APIs & Services template: generated_index.html books: - + id: api-reference-intro + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + path: docs/api-reference-book.yml +- id: app-framework-main-developer-guides git_name: src/app-framework-main path: docs/api-services-book.yml @@ -54,7 +60,6 @@ books: - 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 diff --git a/content/tocs/apis_services/section_halibut.yml b/content/tocs/apis_services/section_halibut.yml new file mode 100644 index 0000000..f53a898 --- /dev/null +++ b/content/tocs/apis_services/section_halibut.yml @@ -0,0 +1,115 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "halibut" + +name: APIs & Services +template: generated_index.html +books: +- + id: api-reference-intro + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + path: docs/api-reference-book.yml +- + 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_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_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 + 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: 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: audio-developer-guides + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + 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_name: automotive-grade-linux/docs-sources + path: docs/hmi-framework-book.yml + dst_prefix: hmi-framework + brotherBooks: + - 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 diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index 5353708..7799aa2 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -7,7 +7,6 @@ books: id: api-reference-intro url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/api-reference-book.yml - @@ -29,7 +28,6 @@ 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 @@ -48,7 +46,6 @@ books: 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 @@ -77,7 +74,6 @@ 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 @@ -94,7 +90,6 @@ 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 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 023e699..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 - - |