Merge branch 'update-docs' of github.itap.purdue.edu:ECN/webqueue2-ap…

…i into update-docs

docs/css/custom_css.css

@@ -7,3 +7,39 @@ table {
   display: table !important;
   border-spacing: 0px !important;
 }
+
+div.autodoc-docstring {
+  padding-left: 20px;
+  margin-bottom: 30px;
+  border-left: 5px solid rgba(230, 230, 230);
+}
+
+div.autodoc-members {
+  padding-left: 20px;
+  margin-bottom: 15px;
+}
+
+div.autodoc-signature *{
+  /*display: none;*/
+  all: initial !important;
+  /*
+  font-style: italic !important;
+  font-feature-settings: "kern","liga" !important;
+  font-family: var(--md-text-font-family,_),-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif !important;
+  */
+  font-feature-settings: inherit !important;
+  font-family: inherit !important;
+  font-size: large !important;
+  font-weight: 600 !important;
+  /*color: #36464e !important;*/
+  color: #7e54b9 !important;
+  /*background-color: #f5f5f5 !important;*/
+}
+em.autodoc-param{
+  font-style: italic !important;
+  font-weight: 500 !important;
+}
+
+.autodoc-docstring{
+  border-color: #977fb8 !important;
+}

docs/ecnqueue.md

@@ -1,21 +1,16 @@
 # ECNQueue documentation
 
-## Item Class
-
-::: webqueue2_api.ECNQueue.Item
+::: webqueue2_api.ECNQueue
     :docstring:
 
-### Item functions
+## Item Class
 
 ::: webqueue2_api.ECNQueue.Item
+    :docstring:
     :members:
 
 ## Queue Class
 
 ::: webqueue2_api.ECNQueue.Queue
     :docstring:
-
-### Queue Functions
-
-::: webqueue2_api.ECNQueue.Queue
-    :memebers:
+    :members:

docs/webqueue2 backend overview.md

@@ -9,4 +9,9 @@ In order to function, the backend of Webqueue2 relies primarily on two scripts,
 ### ECNQueue.py
 The `ECNQueue.py` script does all of the data and information parsing. 
 
-Items are currently stored in plain text within text files and all updates to those items are documented directly into those textfiles via the `qcli`. The `ECNQueue.py` script parses these text files and stores all the information regarding the item into a custom `Item` object.
+Items are currently stored in plain text within text files and all updates to those items are documented directly into those textfiles via the `qcli`. The `ECNQueue.py` script parses these text files and stores all the information regarding the item into a custom `Item` object.
+
+### api.py
+The `api.py` script does all of the interaction between the front end and the `ECNQueue.py` script.
+
+The front end makes requests, which are then routed to the `api.py` script, which are translated to functions within the `ECNQueue.py`. The json that the `ECNQueue.py` script returns is then returned to the `api.py` script which then routes the json to the frontend.