# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+needs_sphinx = '1.6.3'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
'sphinx.ext.doctest',
'sphinx.ext.graphviz',
'sphinx.ext.todo',
- 'sphinx.ext.pngmath',
+ 'sphinx.ext.imgmath',
'sphinx.ext.viewcode',
+ 'sphinxcontrib.blockdiag'
]
# Add any paths that contain templates here, relative to this directory.
# built documents.
#
# The short X.Y version.
-version = 'test'
+version = 'pre-release alpha'
# The full version, including alpha/beta/rc tags.
-release = 'test'
+release = 'Amsterdam 0.1 alpha'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
--- /dev/null
+repo.subrepo.subrepo|API Reference
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+XXXX Component Information
+==========================
+High level architecture, design, and packaging information for release planning and delivery.
+
+.. toctree::
+ :maxdepth: 1
+
+
+Delivery
+--------
+Th package component is composed of the functional layers and packaged into run-time components as illustrated in the following diagrams.
+
+.. blockdiag::
+
+
+ blockdiag layers {
+ orientation = portrait
+ a -> m;
+ b -> n;
+ c -> x;
+ m -> y;
+ m -> z;
+ group l1 {
+ color = blue;
+ x; y; z;
+ }
+ group l2 {
+ color = yellow;
+ m; n;
+ }
+ group l3 {
+ color = orange;
+ a; b; c;
+ }
+
+ }
+
+
+Offered APIs
+------------
+
+.. csv-table::
+ :header-rows: 0
+ :header: "Container or Library", "API Reference", "Purpose", "Protocol", "Port", "TCP/UDP"
+ :widths: 20, 25, 25, 10, 10, 10
+ :delim: |
+ :file: offered-apis.csv
+
+
+Consumed APIs
+-------------
+
+.. csv-table::
+ :header-rows: 0
+ :header: "Project Repo/Group ID", "Container or Library Offering API"
+ :widths: 30, 30
+ :delim: |
+ :file: consumed-apis.csv
+
+Logging & Diagnostic Information
+--------------------------------
+Description of how to interact with and diagnose problems with the components in the run-time packaging.
--- /dev/null
+XXX Container|API Reference link|Create or Delete XYZ|xxx|9999|TCP
+YYY Library|API Reference link|Create or Delete XYZ|xxxx|xxxx|xxxx
+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-****************************
-<Project Name> Release Notes
-****************************
-
-.. toctree::
- :maxdepth: 1
-
- release-notes
+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-
-This document provides the release notes for <RELEASE> of <COMPONENT>.
-
-.. contents::
- :depth: 3
- :local:
-
-
-
-Important notes
-===============
-
-<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>
-
-<EXAMPLE>:
-
-
-
-Summary
-=======
-
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
-
-<EXAMPLE>:
-
tox
-Sphinx==1.3.1
+Sphinx==1.6.3
doc8
docutils
setuptools
six
sphinxcontrib-httpdomain
+sphinxcontrib-blockdiag
sphinx_bootstrap_theme>=0.4.11