#44 Started converting grading to rst; added gradesheet module rst to…

… docs (#45)
CSCI128 · Jan 20, 2023 · 44bcbcb · 44bcbcb
1 parent c127d0f
commit 44bcbcb
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 8 deletions.
diff --git a/docs/source/api/Grade/grade_module.rst b/docs/source/api/Grade/grade_module.rst
@@ -8,8 +8,10 @@ Grade Module
    :maxdepth: 2
 
    grade
+   gradesheets
    post
    score
 
+This document is part of the API documentation
 
-These subsystems make up the grade module
+These subsystems make up the grade module.
diff --git a/docs/source/api/Grade/gradesheets.rst b/docs/source/api/Grade/gradesheets.rst
@@ -0,0 +1,8 @@
+===========
+Gradesheets
+===========
+
+.. automodule:: gradesheets
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst
@@ -1,3 +1,10 @@
 ============
 Architecture
-============
+============
+
+.. note::
+    This document is low priority. If you have urgent questions that aren't answered by reading the API documentation,
+    create a question on GitHub.
+
+While it isn't the same as a proper system diagram, checking out the ``standard grading`` process in the UI is a very
+good example of how the modules interact as it uses all of them and the program was designed with that process in mind.
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -128,9 +128,10 @@ Your file structure (not including the source code) **must** look like this::
 
 
 Initial Setup
----------------------------------------
+-------------
 
-?> I am running the macOS compiled executable 
+.. note::
+    I am running the macOS compiled executable
 
 Ok we are now ready to do our initial setup! 
 
@@ -166,8 +167,9 @@ homepage for the course. It is the numbers after the ``/courses/`` in the url.
 
 .. image:: media/inital_run_2.png
 
-?> There are some table formatting errors, depending on the length of the course names, not all the columns will line up
-it is a fairly minor issue, so it has not yet been fixed.
+.. note::
+    There are some table formatting errors, depending on the length of the course names, not all the columns will line up
+    it is a fairly minor issue, so it has not yet been fixed.
 
 .. image:: media/inital_run_3.png
 

diff --git a/docs/source/grading.rst b/docs/source/grading.rst
@@ -2,5 +2,35 @@
 Grading
 ================
 
-.. note::
-    This is a work in progress
+Overview
+--------
+The Grading system utilizes the the :doc:`api/Grade/grade_module` API to facilitate the grading process.
+
+The general process is as follows:
+
+#. Gradesheets are generated from the source document (:doc:`api/Grade/gradesheets`)
+#. The gradesheet is selected by the Canvas module
+#. The selected gradesheets move the ``Grade.grade`` where: (:doc:`api/Grade/grade`)
+    #. Student scores are scaled
+    #. Missing students are graded
+    #. Extensions are processed
+    #. Late Penalties are applied from the extensions
+#. Then grades are converted to Canvas scores (:doc:`api/Grade/score`)
+#. Finally, grades are posted to Canvas, and a backup Canvas gradebook is generated for manual posting (:doc:`api/Grade/post`)
+
+The above serves as a useful overview for the general flow, but as you may imagine, there is a bit more to grading with this program,
+like, for instance, coming up with the data.
+
+There are 2 grading functions: ``Standard Grading`` and ``Post Pass Fail Assignment``. The below sections will explain how to use them.
+
+
+Standard Grading
+----------------
+
+
+Post Pass Fail Assignment
+-------------------------
+
+
+
+