summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2018-10-27 01:31:43 +0100
committerStephen Finucane <stephen@that.guru>2019-01-29 09:35:08 +0000
commit806f1086bf649383e53095220599fd9f564b117b (patch)
tree32f7ba097cdaac31a567071fcd42f13f5f55b012 /docs/conf.py
parentf825f207e91c2bf88e802e81cdfb1ee72114b2db (diff)
downloadpatchwork-806f1086bf649383e53095220599fd9f564b117b.tar
patchwork-806f1086bf649383e53095220599fd9f564b117b.tar.gz
docs: Integrate API schema into docs
This takes advantage of the sphinxcontrib-openapi Sphinx extension, which allows us to embed the REST API documentation into our docs quite nicely. Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 98c7aa3..f0ca797 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -20,7 +20,11 @@ needs_sphinx = '1.5'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = ['sphinx.ext.todo', 'reno.sphinxext']
+extensions = [
+ 'sphinx.ext.todo',
+ 'reno.sphinxext',
+ 'sphinxcontrib.openapi'
+]
# The theme to use for HTML and HTML Help pages.
html_theme = 'sphinx_rtd_theme'