Finished feature POL1-888-migrate-arch-docs.

build-docs.sh

+sphinx-build -b html -t drawio docs/source docs/build

docs/.gitignore

+*.bkp

docs/source/architecture.rst

+System Architecture Notes
+=========================
+
+
+Components Overview
+----------------------
+
+.. only:: drawio
+
+   .. drawio-image:: architecture.drawio
+      :page-name: components
+
+
+Systems Overview
+----------------------
+
+.. only:: drawio
+
+   .. drawio-image:: architecture.drawio
+      :page-name: deployment
+
+Monitoring Schematic
+----------------------
+
+.. only:: drawio
+
+   .. drawio-image:: architecture.drawio
+      :page-name: monitoring

docs/source/conf.py

@@ -14,7 +14,9 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+from datetime import datetime
 from importlib import import_module
+import importlib.metadata
 from docutils.parsers.rst import Directive
 from docutils import nodes
 from sphinx import addnodes
@@ -55,11 +57,10 @@ def setup(app):
 # -- Project information -----------------------------------------------------
 
 project = 'BRIAN Polling Manager'
-copyright = '2021, swd@geant.org'
-author = 'swd@geant.org'
+copyright = f"{datetime.now().year}, GÉANT"
+author = "swd@geant.org"
 
-# The full version, including alpha/beta/rc tags
-release = '0.0.1'
+release = importlib.metadata.version('brian_polling_manager')
 
 
 # -- General configuration ---------------------------------------------------
@@ -73,6 +74,11 @@ extensions = [
   'sphinx.ext.coverage'
 ]
 
+# the tags variable is injected by sphinx into conf.py
+# (toggle this by running ``sphinx-build -t drawio``)
+if tags.tags.get("drawio", False):  # noqa F821
+    extensions.append("sphinxcontrib.drawio")
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/source/index.rst

@@ -16,5 +16,6 @@ Sensu checks for polling the data required by BRIAN.
    :maxdepth: 2
    :caption: Contents:
 
+   architecture
    main
    api

requirements.txt

@@ -12,3 +12,4 @@ responses
 PyYAML
 sphinx
 sphinx-rtd-theme
+sphinxcontrib-drawio