Merge pull request #38 from OpenLXP/admindocs

add admin docs

app/openlxp_xss_project/settings.py

@@ -43,6 +43,7 @@
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
+    'django.contrib.admindocs',
     'corsheaders',
     'rest_framework',
     'rest_framework.authtoken',
@@ -61,6 +62,7 @@
     'django.contrib.auth.middleware.AuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'django.contrib.admindocs.middleware.XViewMiddleware',
 ]
 
 ROOT_URLCONF = 'openlxp_xss_project.urls'

app/openlxp_xss_project/urls.py

@@ -20,6 +20,7 @@
 from django.urls import include, path
 
 urlpatterns = [
+    path('admin/doc/', include('django.contrib.admindocs.urls')),
     url('', include('openlxp_authentication.urls')),
     path('admin/', admin.site.urls),
     path('api/', include('api.urls')),

requirements.txt

@@ -10,6 +10,8 @@ Django>=3.2,<4.0
 
 djangorestframework>=3.12.2,<3.13.0
 
+docutils>=0.20.1
+
 flake8>=3.9.0,<4.0.1
 
 gunicorn>=20.0.4,<20.1.0