Migrate Architecture doc to RTD

Change-Id: Ibed073a93ed1fc660a3b6ea36a608e76d9cc8b1e
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644 (file)
index 0000000..20daf5f
--- /dev/null
+++ b/docs/architecture.rst
@@ -0,0 +1,23 @@
+############
+Architecture
+############
+
+.. uml::
+
+   @startuml
+   package "MD-SAL Project" {
+
+       () "MD-SAL Binding API" as mdsal.binding.api
+       () "MD-SAL DOM API" as mdsal.dom.api
+       [Binding Adapter] as mdsal.binding.adapter
+       [Binding Data Codec] as mdsal.binding.codec
+       [MD-SAL DOM Router] as mdsal.dom.router
+       () "MD-SAL Shard SPI" as mdsal.shard.spi
+
+       mdsal.binding.adapter --> mdsal.binding.codec : uses
+       mdsal.binding.api -- mdsal.binding.adapter
+       mdsal.binding.adapter .> mdsal.dom.api : uses
+       mdsal.dom.api -- mdsal.dom.router
+       mdsal.dom.router -- mdsal.shard.spi
+   }
+   @enduml

diff --git a/docs/conf.py b/docs/conf.py
index 925316abfa248333bf07605e24fc4a9ad928c78e..537834136c6bd90c242cc9699ec7bd501a626aa8 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -12,3 +12,4 @@
 
 from docs_conf.conf import *
 
+extensions.append('sphinxcontrib.plantuml')

diff --git a/docs/index.rst b/docs/index.rst
index e1be1d3325ac9b0dcec1c02d685c7888a36b8c86..dc4a0e97cc42f5cc358d6f73a2742ecf7da165b1 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -115,3 +115,9 @@ of API-centric integration.
   * Transactional **modification** to conceptual **data tree** - write
     transactions with isolation from other running transactions.
   * **Transaction chaining**
+
+
+  .. toctree::
+     :maxdepth: 1
+
+     architecture

diff --git a/docs/requirements.txt b/docs/requirements.txt
index 74a3b7a3fd3305adeb46657771ca0364cdf4ac86..b72cc45d9e7fa1efd63fde248f63e6d576f6df7a 100644 (file)
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1 +1,2 @@
 lfdocs-conf
+sphinxcontrib-plantuml