Make docs slightly more uniform than before (#60)

* Add subheadings for classes in models and forms * Group functions in views and handler in docs * Remove unnecessary spaces * Clean up docs
vbsinha · May 2, 2019 · c8a2694 · c8a2694
1 parent 64161f9
commit c8a2694
Show file tree

Hide file tree

Showing 8 changed files with 294 additions and 124 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -39,3 +39,6 @@
 
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_theme_options = {
+    'collapse_navigation': False
+}
diff --git a/docs/source/forms.rst b/docs/source/forms.rst
@@ -3,29 +3,64 @@ Forms and input pre-processing
 
 .. automodule:: judge.forms
 
+Creation forms
+--------------
+
+NewContestForm
+~~~~~~~~~~~~~~
     .. autoclass:: NewContestForm
         :members:
 
+NewProblemForm
+~~~~~~~~~~~~~~
     .. autoclass:: NewProblemForm
         :members:
 
+NewSubmissionForm
+~~~~~~~~~~~~~~~~~
     .. autoclass:: NewSubmissionForm
         :members:
 
+NewCommentForm
+~~~~~~~~~~~~~~
     .. autoclass:: NewCommentForm
         :members:
 
+Extension forms
+---------------
+
+AddPersonToContestForm
+~~~~~~~~~~~~~~~~~~~~~~
     .. autoclass:: AddPersonToContestForm
         :members:
 
+AddTestCaseForm
+~~~~~~~~~~~~~~~
     .. autoclass:: AddTestCaseForm
         :members:
 
+AddPosterScoreForm
+~~~~~~~~~~~~~~~~~~
+    .. autoclass:: AddPosterScoreForm
+        :members:
+
+Updation forms
+--------------
+
+UpdateContestForm
+~~~~~~~~~~~~~~~~~
     .. autoclass:: UpdateContestForm
         :members:
 
+EditProblemForm
+~~~~~~~~~~~~~~~
     .. autoclass:: EditProblemForm
         :members:
 
-    .. autoclass:: DeletePersonFromContest
+Deletion forms
+--------------
+
+DeletePersonFromContestForm
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    .. autoclass:: DeletePersonFromContestForm
         :members:
diff --git a/docs/source/handler.rst b/docs/source/handler.rst
@@ -2,4 +2,50 @@ Handlers and database management
 ================================
 
 .. automodule:: judge.handler
-    :members:
+
+Process Functions
+-----------------
+
+    .. autofunction:: process_contest
+    .. autofunction:: process_problem
+    .. autofunction:: process_solution
+    .. autofunction:: process_testcase
+    .. autofunction:: process_person
+    .. autofunction:: process_comment
+
+Addition Functions
+------------------
+
+    .. autofunction:: add_person_to_contest
+    .. autofunction:: add_person_rgx_to_contest
+    .. autofunction:: add_persons_to_contest
+
+Update Functions
+----------------
+
+    .. autofunction:: update_problem
+    .. autofunction:: update_poster_score
+    .. autofunction:: update_leaderboard
+
+Getter Functions
+----------------
+
+    .. autofunction:: get_personcontest_permission
+    .. autofunction:: get_personproblem_permission
+    .. autofunction:: get_posters
+    .. autofunction:: get_participants
+    .. autofunction:: get_personcontest_score
+    .. autofunction:: get_submission_status
+    .. autofunction:: get_submission_status_mini
+    .. autofunction:: get_submissions
+    .. autofunction:: get_leaderboard
+    .. autofunction:: get_comments
+    .. autofunction:: get_csv
+
+Deletion Functions
+------------------
+
+    .. autofunction:: delete_contest
+    .. autofunction:: delete_problem
+    .. autofunction:: delete_testcase
+    .. autofunction:: delete_personcontest
diff --git a/docs/source/models.rst b/docs/source/models.rst
@@ -3,38 +3,62 @@ Models and Database Schema
 
 .. automodule:: judge.models
 
+Base Models
+-----------
+
+Contest
+~~~~~~~
     .. autoclass:: Contest
         :members:
         :exclude-members: DoesNotExist, MultipleObjectsReturned
 
+Problem
+~~~~~~~~~
     .. autoclass:: Problem
         :members:
         :exclude-members: DoesNotExist, MultipleObjectsReturned
 
-    .. autoclass:: Person
+Submission
+~~~~~~~~~~
+    .. autoclass:: Submission
         :members:
         :exclude-members: DoesNotExist, MultipleObjectsReturned
 
-    .. autoclass:: ContestPerson
+TestCase
+~~~~~~~~
+    .. autoclass:: TestCase
         :members:
         :exclude-members: DoesNotExist, MultipleObjectsReturned
 
-    .. autoclass:: Submission
+Person
+~~~~~~
+    .. autoclass:: Person
         :members:
         :exclude-members: DoesNotExist, MultipleObjectsReturned
 
-    .. autoclass:: TestCase
+Comment
+~~~~~~~
+    .. autoclass:: Comment
         :members:
         :exclude-members: DoesNotExist, MultipleObjectsReturned
 
-    .. autoclass:: SubmissionTestCase
+Derived Models
+--------------
+
+ContestPerson
+~~~~~~~~~~~~~
+    .. autoclass:: ContestPerson
         :members:
         :exclude-members: DoesNotExist, MultipleObjectsReturned
 
-    .. autoclass:: Comment
+SubmissionTestCase
+~~~~~~~~~~~~~~~~~~
+    .. autoclass:: SubmissionTestCase
         :members:
         :exclude-members: DoesNotExist, MultipleObjectsReturned
 
+PersonProblemFinalScore
+~~~~~~~~~~~~~~~~~~~~~~~
     .. autoclass:: PersonProblemFinalScore
         :members:
         :exclude-members: DoesNotExist, MultipleObjectsReturned
diff --git a/docs/source/views.rst b/docs/source/views.rst
@@ -2,4 +2,54 @@ Views and page rendering
 ========================
 
 .. automodule:: judge.views
-    :members:
+
+Default Views
+-------------
+
+    .. autofunction:: index
+
+    .. autofunction:: handler404
+
+    .. autofunction:: handler500
+
+Creation Views
+--------------
+
+    .. autofunction:: new_contest
+    .. autofunction:: new_problem
+
+Modification Views
+------------------
+
+    .. autofunction:: edit_problem
+    .. autofunction:: add_person
+    .. autofunction:: add_poster
+    .. autofunction:: add_participant
+
+Detail Views
+------------
+
+    .. autofunction:: contest_detail
+    .. autofunction:: problem_detail
+    .. autofunction:: submission_detail
+    .. autofunction:: get_people
+    .. autofunction:: get_posters
+    .. autofunction:: get_participants
+    .. autofunction:: problem_submissions
+
+Deletion Views
+--------------
+
+    .. autofunction:: delete_contest
+    .. autofunction:: delete_problem
+    .. autofunction:: delete_testcase
+
+Downloading Views
+-----------------
+
+    .. autofunction:: contest_scores_csv
+    .. autofunction:: problem_starting_code
+    .. autofunction:: problem_compilation_script
+    .. autofunction:: problem_test_script
+    .. autofunction:: problem_default_script
+    .. autofunction:: submission_download
diff --git a/judge/forms.py b/judge/forms.py
@@ -128,7 +128,7 @@ class AddPersonToContestForm(forms.Form):
     """Email ID of the person"""
 
 
-class DeletePersonFromContest(forms.Form):
+class DeletePersonFromContestForm(forms.Form):
     """
     Form to remove a Person from a Contest.
     """