Add drf_yasg app for creating automated documentation
Further cleanup code to match the expectations of the linters and
add tox commands for building the documentation.
Issue: HIC-167
Change-Id: I816a578bc7995f4560c19003d0cc907a22e740b6
diff --git a/hiccup/settings.py b/hiccup/settings.py
index 42b15bb..f20c3c8 100644
--- a/hiccup/settings.py
+++ b/hiccup/settings.py
@@ -54,6 +54,7 @@
'allauth.account',
'allauth.socialaccount',
'allauth.socialaccount.providers.google',
+ 'drf_yasg'
]
MIDDLEWARE_CLASSES = [
@@ -212,6 +213,14 @@
},
}
+
+# Automatic documentation generation
+# https://drf-yasg.readthedocs.io/en/stable/index.html
+
+SWAGGER_SETTINGS = {
+ 'DEFAULT_INFO': 'hiccup.urls.api_info',
+}
+
try:
from local_settings import * # noqa: F403, F401
except ImportError as e: