Skip to content
Snippets Groups Projects
Commit 94a4a1f9 authored by Erik Reid's avatar Erik Reid
Browse files

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

parents 79310a58 06bb338c
No related branches found
No related tags found
No related merge requests found
sphinx-build -b html -t drawio docs/source docs/build
*.bkp
This diff is collapsed.
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
......@@ -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']
......
......@@ -16,5 +16,6 @@ Sensu checks for polling the data required by BRIAN.
:maxdepth: 2
:caption: Contents:
architecture
main
api
......@@ -12,3 +12,4 @@ responses
PyYAML
sphinx
sphinx-rtd-theme
sphinxcontrib-drawio
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment