From 59922f616227205457f09d60845ec67a9e1340d4 Mon Sep 17 00:00:00 2001 From: ewuerger Date: Mon, 6 Feb 2023 13:14:16 +0100 Subject: [PATCH] docs: Update model architecture and use diagram in index page --- .github/workflows/docs.yml | 6 +- docs/api/rm-bridge.aird | 1901 +++++++++++++++++++++++++++++++++++- docs/api/rm-bridge.capella | 30 +- docs/source/conf.py | 5 + docs/source/index.rst | 2 + pyproject.toml | 7 +- 6 files changed, 1895 insertions(+), 56 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ec21d61..9a3dad6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,7 +5,7 @@ name: Docs on: push: - branches: ["master"] + branches: ["add-docs"] jobs: sphinx: @@ -13,10 +13,10 @@ jobs: permissions: contents: write steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: fetch-depth: 0 - - uses: actions/setup-python@v2 + - uses: actions/setup-python@v4 with: python-version: "3.10" - name: Upgrade pip diff --git a/docs/api/rm-bridge.aird b/docs/api/rm-bridge.aird index 4c6dbd9..79148b5 100644 --- a/docs/api/rm-bridge.aird +++ b/docs/api/rm-bridge.aird @@ -11,7 +11,7 @@ - +
@@ -23,6 +23,14 @@ + + +
+
+ + + + @@ -181,7 +189,7 @@ - + @@ -245,7 +253,7 @@ - + @@ -333,7 +341,7 @@ - + @@ -377,7 +385,7 @@ - + @@ -663,7 +671,7 @@ - + @@ -927,17 +935,17 @@ - + - + - + - + @@ -959,49 +967,49 @@ - + - + - + - + - + - + - + - + - + - + - + @@ -1010,7 +1018,7 @@ - + @@ -1023,23 +1031,23 @@ - + - + - + - + - + @@ -1058,7 +1066,7 @@ - + @@ -1140,7 +1148,7 @@ - + @@ -1731,7 +1739,7 @@ - + @@ -1744,7 +1752,7 @@ - + @@ -1757,7 +1765,7 @@ - + @@ -1770,7 +1778,7 @@ - + @@ -1889,7 +1897,7 @@ - + @@ -4697,7 +4705,7 @@ - + @@ -4705,7 +4713,7 @@ - + @@ -4911,4 +4919,1825 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + italic + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + routingStyle + + + + + + + + + + + + routingStyle + + + + + + + + + + + + routingStyle + + + + + + + + + + + + routingStyle + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + routingStyle + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + routingStyle + + + + + + + + + + + + routingStyle + + + + + + + + + + + + + routingStyle + + + + + + + + + + + + + + routingStyle + + + + + + + + + + + + + routingStyle + + + + + + + + + + + + + routingStyle + + + + + + + + + + + + routingStyle + + + + + + + + + + + + routingStyle + + + + + + + + + + + + routingStyle + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + routingStyle + + + + + + + + + + + + + routingStyle + + + + + + + + + + + + routingStyle + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + KEEP_LOCATION + KEEP_SIZE + KEEP_RATIO + + + + + + + + + + + + + + + + + + + diff --git a/docs/api/rm-bridge.capella b/docs/api/rm-bridge.capella index 9f2ce43..45cafbf 100644 --- a/docs/api/rm-bridge.capella +++ b/docs/api/rm-bridge.capella @@ -414,17 +414,17 @@ id="e9e4e78d-bd4a-4c29-b941-85de358167d0" name="exec call" target="#ef5a8cab-b816-4569-b507-1e92cf13f47c" source="#00554c9c-8b15-4695-8553-35700a52e8e0"/> + id="0e55d264-1fb3-4f0c-a36d-fd9ff005ed6d" name="" target="#c6330ad4-c13f-48b9-87d5-d1318f571b10" + source="#bdb6d5b4-fda4-4136-951c-abc51ff69047"/> + id="3b6b570f-558e-484e-88d4-874506eb4381" name="" target="#cf425c50-596a-4e51-9304-50e3076040de" + source="#a1a223de-fda2-4900-bd82-f7f4ceecef5c"/> + id="9a8227e9-a5e1-4570-84d3-b6f37a7349a1" name="" target="#77dd57b2-66eb-4bcf-ab45-cbe902352f0d" + source="#dae9e41f-d5b7-4e7e-9819-bbe74a67e791"/> + id="140a3ae2-18cb-44de-baa6-b29c3890dc0d" name="" target="#77dd57b2-66eb-4bcf-ab45-cbe902352f0d" + source="#395e4d10-ef01-4be4-9fed-cf15b78d979f"/> @@ -438,8 +438,8 @@ id="4b788388-1390-4854-8d05-9847aa35c3fc" name="RM Sync Config" target="#d23d353a-c0dd-4ffc-8c15-a41ff7461b34" source="#c36fd5a5-dc75-46ce-ac95-087b38bf1afc"/> + id="600f2316-7868-43ab-8ddc-ba7b0bd51c8f" name="" target="#063865d4-22a2-4a74-afce-f4a9452657de" + source="#29a1eabf-7d9a-4c4f-8a34-cbef81e9464c"/> @@ -453,7 +453,7 @@ id="8903f59e-68fd-407e-9d18-959b136fc7ca" name="[ES] Sync reqs from RM tool to T4C" kind="DATA_FLOW"> + id="6b5d5c53-44a3-4e34-9ccb-08c3c3c52b73" name="RM Bridge" representedInstance="#306a87b4-5d94-4193-8006-dd1889b689ec"/> @@ -987,7 +987,7 @@ + name="RM Bridge" abstractType="#de33768b-224a-40f9-b9da-1c11f41ae137"/> + id="de33768b-224a-40f9-b9da-1c11f41ae137" name="RM Bridge"> + name="Capella RM Bridge" abstractType="#eb0c8943-34ad-4bda-ae5a-d7d488de0005"/> + id="eb0c8943-34ad-4bda-ae5a-d7d488de0005" name="Capella RM Bridge"> diff --git a/docs/source/conf.py b/docs/source/conf.py index 903017c..aaa87cc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -40,6 +40,7 @@ "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", + "capellambse.sphinx", ] # Add any paths that contain templates here, relative to this directory. @@ -82,6 +83,10 @@ } +# -- Options for CapellaMBSE-Sphinx ------------------------------------------ +capellambse_model = "../api/rm-bridge.aird" + + # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for diff --git a/docs/source/index.rst b/docs/source/index.rst index 6d8cffd..d81ef23 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,6 +26,8 @@ SIEMENS' `Polarion`_. So all this library does is, based on an exported It is essential for a safe **synchronization process of ReqIFElements** from any RM tool to Capella via `capellambse`_. +.. diagram:: [LAB] Just Architecture + .. toctree:: :hidden: :maxdepth: 2 diff --git a/pyproject.toml b/pyproject.toml index 095826d..1912b19 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -48,9 +48,12 @@ Documentation = "https://dsd-dbs.github.io/capella-rm-bridge" [project.optional-dependencies] docs = [ - "sphinx", + "furo", + "nbsphinx", + "pyyaml", + "sphinx-argparse-cli", "sphinx-autobuild", - "sphinx-rtd-theme", + "sphinx", "tomli", ]