From 6b0deaceb146ed1c066c8ae12e70162356b4ff10 Mon Sep 17 00:00:00 2001 From: Hanne Moa Date: Fri, 28 Apr 2023 12:29:30 +0200 Subject: [PATCH] Openapi in sphinx, not done --- docs/conf.py | 1 + docs/index.rst | 4 +++- pyproject.toml | 5 ++++- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index fbe47e46a..a4aa06e7a 100644 --- 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 index 738dd976b..60042e132 100644 --- 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 index 334966c55..3274ef89d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -50,7 +50,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",