From d5d3da78fe8a5796510e18fe793a57cbbd896d4a Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Tue, 31 Jul 2018 21:34:53 -0400 Subject: [PATCH] Migrate Architecture doc to RTD Change-Id: Ibed073a93ed1fc660a3b6ea36a608e76d9cc8b1e Signed-off-by: Thanh Ha --- docs/architecture.rst | 23 +++++++++++++++++++++++ docs/conf.py | 1 + docs/index.rst | 6 ++++++ docs/requirements.txt | 1 + 4 files changed, 31 insertions(+) create mode 100644 docs/architecture.rst diff --git a/docs/architecture.rst b/docs/architecture.rst new file mode 100644 index 0000000000..20daf5f20b --- /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 925316abfa..537834136c 100644 --- 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 e1be1d3325..dc4a0e97cc 100644 --- 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 74a3b7a3fd..b72cc45d9e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ lfdocs-conf +sphinxcontrib-plantuml -- 2.36.6