From d6026882a7968ed704e024c3b3016e20d56fdca4 Mon Sep 17 00:00:00 2001
From: Erik Reid <erik.reid@geant.org>
Date: Tue, 11 Mar 2025 14:05:39 +0100
Subject: [PATCH] added sphinxcontrib-drawio support
---
build-docs.sh | 1 +
docs/source/conf.py | 14 ++++++++++----
requirements.txt | 1 +
3 files changed, 12 insertions(+), 4 deletions(-)
create mode 100755 build-docs.sh
diff --git a/build-docs.sh b/build-docs.sh
new file mode 100755
index 0000000..c1dcfdd
--- /dev/null
+++ b/build-docs.sh
@@ -0,0 +1 @@
+sphinx-build -b html -t drawio docs/source docs/build
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 2db47d2..745a47b 100644
--- a/docs/source/conf.py
+++ b/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']
diff --git a/requirements.txt b/requirements.txt
index 996d8f1..f6d3440 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -12,3 +12,4 @@ responses
PyYAML
sphinx
sphinx-rtd-theme
+sphinxcontrib-drawio
--
GitLab