aboutsummaryrefslogtreecommitdiffstats
path: root/site/_tocs/apis_services
diff options
context:
space:
mode:
authorStephane Desneux <stephane.desneux@iot.bzh>2016-11-15 02:10:13 +0100
committerStephane Desneux <stephane.desneux@iot.bzh>2016-11-15 03:05:34 +0100
commit96baf20ed87b231082751481c1dbcfd737851ff2 (patch)
tree054526b55c79945a5db1f93cb326731d2d46a10e /site/_tocs/apis_services
parent6202af6a782398faefc3fd1da71911d80f63a276 (diff)
webdocs: allow fetching PDFs; update documentation in _tocs files
Change-Id: I9b677f0ad3b161ffb12471a989f5e8ca455baab2 Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
Diffstat (limited to 'site/_tocs/apis_services')
-rw-r--r--site/_tocs/apis_services/fetched_files.yml94
-rw-r--r--site/_tocs/apis_services/toc_dev_en.yml43
2 files changed, 120 insertions, 17 deletions
diff --git a/site/_tocs/apis_services/fetched_files.yml b/site/_tocs/apis_services/fetched_files.yml
index ae29d2c..a8d51d1 100644
--- a/site/_tocs/apis_services/fetched_files.yml
+++ b/site/_tocs/apis_services/fetched_files.yml
@@ -1,24 +1,44 @@
-# REFERENCE ENTRY:
+##############################################################################################################
+# 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% %uri%
-# GERRIT_FETCH= "https://gerrit.automotivelinux.org/gerrit/gitweb?p=%repo%;a=blob_plain;f=%source%;hb=%commit%"
-# GITHUB_FETCH= "https://raw.githubusercontent.com/%repo%/%commit%/%source%"
-# repository: git repository name
-# GITHUB_EDIT= "https://raw.github.com/%repo%/blob/%commit%/%source%"
-# git_commit: git commit when not default
-# destination_prefix: optional destination prefix
-# documents:
-# -
-# source : "source patch within url_fetch"
-# destination : "optional: destination path default=path.join(destination_prefix+source)"
-# label: "optional: friendly name for submenu default=basename(source) overloaded by file content"
-# title: "optional: info about document (default label, overloaded by file content)"
+# 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 : "master"
-#git_commit : # default defined in _tocs/xxxx/latest.yml
-#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source)
repositories:
-
@@ -61,5 +81,45 @@ repositories:
- source: afb-bindings-overview.md
label: Bindings Examples
- source: FAQ.md
-
+-
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-agl
+ git_commit: master
+ src_prefix: docs/app-framework
+ dst_prefix: af-binder
+ documents:
+ - source: index.md
+ destination: resources.md
+ label: Resources
+-
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-agl
+ git_commit: master
+ src_prefix: docs/signaling
+ dst_prefix: signaling
+ documents:
+ - source: architecture.md
+ destination: architecture.md
+ label: Signaling Architecture (proposal)
+ - 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/distributed-arch.svg
+ - source: images/signal-agent-arch.svg
+-
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-agl
+ git_commit: master
+ src_prefix: docs/audio
+ dst_prefix: audio
+ documents:
+ - source: index.md
+ destination: resources.md
+ label: Resources
diff --git a/site/_tocs/apis_services/toc_dev_en.yml b/site/_tocs/apis_services/toc_dev_en.yml
index fd83f87..1262d1a 100644
--- a/site/_tocs/apis_services/toc_dev_en.yml
+++ b/site/_tocs/apis_services/toc_dev_en.yml
@@ -1,6 +1,39 @@
+#######################################################################
# 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/AppDefault.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
@@ -22,5 +55,15 @@ children:
- url: reference/af-binder/afb-tests-overview.html
- url: reference/af-binder/afb-bindings-overview.html
- url: reference/af-binder/FAQ.html
+ - url: reference/af-binder/resources.html
+-
+ name: Message Signaling
+ children:
+ - url: reference/signaling/architecture.html
+ - url: reference/signaling/resources.html
+-
+ name: Audio Framework
+ children:
+ - url: reference/audio/resources.html