GITC-57: Introduces admindocs to create admin pages from our models (#…

…9179)
gitcoinco · Jun 23, 2021 · ebff0ee · ebff0ee
1 parent 9b59ff2
commit ebff0ee
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 4 deletions.
diff --git a/app/app/settings.py b/app/app/settings.py
@@ -85,6 +85,7 @@
     'django.contrib.admin',
     'taskapp.celery.CeleryConfig',
     'django_celery_beat',
+    'django.contrib.admindocs',
     'django.contrib.auth',
     'django.contrib.contenttypes',
     'django.contrib.sessions',

diff --git a/app/app/urls.py b/app/app/urls.py
@@ -295,7 +295,7 @@
         dashboard.views.funder_dashboard_bounty_info,
         name='funder_dashboard_bounty_info'
     ),
-    
+
 
     # quests
     re_path(r'^quests/?$', quests.views.index, name='quests_index'),
@@ -771,6 +771,9 @@
     ),
     re_path(r'^_administration/email/match_distribution$', retail.emails.match_distribution, name='match_distribution'),
 
+    # docs
+    re_path(r'^_administration/docs/',include('django.contrib.admindocs.urls')),
+
     # settings
     re_path(r'^settings/email/(.*)', marketing.views.email_settings, name='email_settings'),
     re_path(r'^settings/privacy/?', marketing.views.privacy_settings, name='privacy_settings'),

diff --git a/app/dashboard/models.py b/app/dashboard/models.py
@@ -2841,10 +2841,11 @@ def __str__(self):
 
 
 class Profile(SuperModel):
-    """Define the structure of the user profile.
+    """
+        Define the structure of the user profile.
 
-    TODO:
-        * Remove all duplicate identity related information already stored on User.
+        TODO:
+            * Remove all duplicate identity related information already stored on User.
 
     """
 

diff --git a/app/retail/templates/admin/index.html b/app/retail/templates/admin/index.html
@@ -120,6 +120,9 @@ <h2>{% trans 'Administrative Tasks' %}</h2>
     <ul>
       <a href="/_administrationfaucet/faucetrequest/?fulfilled=f&rejected=f">Process Faucet Requests</a>
     </ul>
+    <ul>
+      <a href="/_administration/docs">View the admin docs</a>
+    </ul>
   </div>
 
 

diff --git a/requirements/base.txt b/requirements/base.txt
@@ -115,3 +115,4 @@ rjsmin==1.1.0
 rcssmin==1.0.6
 libsass==0.20.1
 graphqlclient==0.2.4
+docutils==0.17.1
-Original file line number
+Diff line change
@@ Expand Up / @@ -120,6 +120,9 @@ <h2>{% trans 'Administrative Tasks' %}</h2> @@
         <ul>
           <a href="/_administrationfaucet/faucetrequest/?fulfilled=f&rejected=f">Process Faucet Requests</a>
         </ul>
+        <ul>
+          <a href="/_administration/docs">View the admin docs</a>
+        </ul>
       </div>
@@ Expand Down @@