Finish sphinx documentation

StefanRudvin · Apr 18, 2018 · 833089e · 833089e
1 parent d3df549
commit 833089e
Show file tree

Hide file tree

Showing 14 changed files with 110 additions and 8 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,17 @@
 Welcome to CodeMarker's documentation!
 ======================================
 
+Feel free to explore each component at your discertion. You can also search the docs using the input field in the sidebar.
+
+Please note that the Django-generated files haven't been documented. Please refer to Django's documentation for their overview.
+
+Contact Team Alpha in case of any issues:
+
+- Konrad Dryja – k.dryja.15@aberdeen.ac.uk
+- Stefan Rudvin – stefan.rudvin@hotmail.com
+- Elzbieta Futkowska - e.futkowska.15@aberdeen.ac.uk
+- Tautvydas Cerniauskas - tautvydas.cer@gmail.com
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
@@ -14,6 +25,15 @@ Welcome to CodeMarker's documentation!
    modules/views
    modules/processor
    modules/factory
+   modules/docker_processor
+   modules/serializers
+   modules/backup_service
+   modules/test_assessments
+   modules/test_backup
+   modules/test_courses_users
+   modules/test_courses
+   modules/test_submissions
+   modules/test_users
 
 Indices and tables
 ==================

diff --git a/docs/modules/backup_service.rst b/docs/modules/backup_service.rst
@@ -0,0 +1,11 @@
+.. toctree::
+   :maxdepth: 5
+   :caption: Contents:
+
+backup_service.py
+======
+.. automodule:: app.backup_service
+    :members:
+    :show-inheritance:
+    :inherited-members:
+
diff --git a/docs/modules/docker_processor.rst b/docs/modules/docker_processor.rst
@@ -0,0 +1,11 @@
+.. toctree::
+   :maxdepth: 5
+   :caption: Contents:
+
+docker_processor.py
+======
+.. automodule:: app.docker_processor
+    :members:
+    :show-inheritance:
+    :inherited-members:
+
diff --git a/docs/modules/factory.rst b/docs/modules/factory.rst
@@ -2,10 +2,9 @@
    :maxdepth: 5
    :caption: Contents:
 
-Factory
+factory.py
 ======
 .. automodule:: app.factory
     :members:
     :show-inheritance:
-    :inherited-members:
 
diff --git a/docs/modules/models.rst b/docs/modules/models.rst
@@ -2,10 +2,9 @@
    :maxdepth: 5
    :caption: Contents:
 
-Models
+models.py
 ======
 .. automodule:: app.models
     :members:
     :show-inheritance:
-    :inherited-members:
 
diff --git a/docs/modules/processor.rst b/docs/modules/processor.rst
@@ -2,10 +2,9 @@
    :maxdepth: 5
    :caption: Contents:
 
-Processor
+submission_processor.py
 ======
 .. automodule:: app.submission_processor
     :members:
     :show-inheritance:
-    :inherited-members:
 
diff --git a/docs/modules/serializers.rst b/docs/modules/serializers.rst
@@ -0,0 +1,10 @@
+.. toctree::
+   :maxdepth: 5
+   :caption: Contents:
+
+serializers.py
+======
+.. automodule:: app.serializers
+    :members:
+    :show-inheritance:
+
diff --git a/docs/modules/test_assessments.rst b/docs/modules/test_assessments.rst
@@ -0,0 +1,9 @@
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+test_assessments.py
+======
+.. automodule:: app.tests.test_assessments
+    :members:
+    :show-inheritance:
diff --git a/docs/modules/test_backup.rst b/docs/modules/test_backup.rst
@@ -0,0 +1,9 @@
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+test_backup.py
+======
+.. automodule:: app.tests.test_backup
+    :members:
+    :show-inheritance:
diff --git a/docs/modules/test_courses.rst b/docs/modules/test_courses.rst
@@ -0,0 +1,9 @@
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+test_courses.py
+======
+.. automodule:: app.tests.test_courses
+    :members:
+    :show-inheritance:
diff --git a/docs/modules/test_courses_users.rst b/docs/modules/test_courses_users.rst
@@ -0,0 +1,9 @@
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+test_courses_users.py
+======
+.. automodule:: app.tests.test_courses_users
+    :members:
+    :show-inheritance:
diff --git a/docs/modules/test_submissions.rst b/docs/modules/test_submissions.rst
@@ -0,0 +1,9 @@
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+test_submissions.py
+======
+.. automodule:: app.tests.test_submissions
+    :members:
+    :show-inheritance:
diff --git a/docs/modules/test_users.rst b/docs/modules/test_users.rst
@@ -0,0 +1,9 @@
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+test_users.py
+======
+.. automodule:: app.tests.test_users
+    :members:
+    :show-inheritance:
diff --git a/docs/modules/views.rst b/docs/modules/views.rst
@@ -2,9 +2,8 @@
    :maxdepth: 2
    :caption: Contents:
 
-Views
+views.py
 ======
 .. automodule:: app.views
     :members:
     :show-inheritance:
-    :inherited-members: