Openapi in sphinx, not done

Uninett · Apr 17, 2024 · a672b47 · a672b47
1 parent 615b760
commit a672b47
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -52,6 +52,7 @@
     "sphinx.ext.coverage",
     "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",
+    "sphinxcontrib.openapi",
     "djangodocs",
 ]
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,7 +6,9 @@
 Welcome to Argus' documentation!
 ================================
 
-   Argus is an alert aggregator for monitoring systems.
+Argus is an alert aggregator for monitoring systems.
+
+.. openapi:: ../argus-openapi.yml
 
 .. toctree::
    about-argus

diff --git a/pyproject.toml b/pyproject.toml
@@ -49,7 +49,10 @@ dynamic = ["version"]
 "Homepage" = "https://github.com/Uninett/Argus"
 
 [project.optional-dependencies]
-docs = ["sphinx>=2.2.0"]
+docs = [
+    "sphinx>=2.2.0",
+    "sphinxcontrib-openapi",
+]
 dev = [
     "black",
     "coverage",