added documentation markdown

asuc-octo · Mar 22, 2020 · a563ee2 · a563ee2
1 parent 33a9086
commit a563ee2
Show file tree

Hide file tree

Showing 28 changed files with 47 additions and 153 deletions.
diff --git a/_build/doctrees/berkeleytime/berkeleytime.doctree b/_build/doctrees/berkeleytime/berkeleytime.doctree
diff --git a/_build/doctrees/berkeleytime/berkeleytime/berkeleytime.doctree b/_build/doctrees/berkeleytime/berkeleytime/berkeleytime.doctree
diff --git a/_build/doctrees/build/build.doctree b/_build/doctrees/build/build.doctree
diff --git a/_build/doctrees/environment.pickle b/_build/doctrees/environment.pickle
diff --git a/_build/doctrees/frontend/frontend.doctree b/_build/doctrees/frontend/frontend.doctree
diff --git a/_build/doctrees/index.doctree b/_build/doctrees/index.doctree
diff --git a/_build/html/_sources/berkeleytime/berkeleytime.rst.txt b/_build/html/_sources/berkeleytime/berkeleytime.rst.txt
@@ -12,11 +12,3 @@ BerkeleyTime
    marketplace/marketplace
    mondaine/mondaine
    scheduler/scheduler
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/_build/html/_sources/berkeleytime/berkeleytime/berkeleytime.rst.txt b/_build/html/_sources/berkeleytime/berkeleytime/berkeleytime.rst.txt
@@ -21,10 +21,3 @@ views.py
    :members:
    :undoc-members:
    :show-inheritance:
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/_build/html/_sources/build/build.rst.txt b/_build/html/_sources/build/build.rst.txt
@@ -3,12 +3,3 @@ Build
 
 .. toctree::
    :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/_build/html/_sources/frontend/frontend.rst.txt b/_build/html/_sources/frontend/frontend.rst.txt
@@ -3,12 +3,3 @@ Frontend
 
 .. toctree::
    :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/_build/html/_sources/index.rst.txt b/_build/html/_sources/index.rst.txt
@@ -12,11 +12,3 @@ Welcome to berkeleytime's documentation!
    berkeleytime/berkeleytime
    build/build
    frontend/frontend
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/_build/html/berkeleytime/berkeleytime.html b/_build/html/berkeleytime/berkeleytime.html
@@ -59,10 +59,7 @@ <h1>BerkeleyTime<a class="headerlink" href="#berkeleytime" title="Permalink to t
 </li>
 <li class="toctree-l2"><a class="reference internal" href="berkeleytime/berkeleytime.html#settings-py">settings.py</a></li>
 <li class="toctree-l2"><a class="reference internal" href="berkeleytime/berkeleytime.html#urls-py">urls.py</a></li>
-<li class="toctree-l2"><a class="reference internal" href="berkeleytime/berkeleytime.html#module-berkeleytime.views">views.py</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="berkeleytime/berkeleytime.html#indices-and-tables">Indices and tables</a></li>
-</ul>
-</li>
+<li class="toctree-l2"><a class="reference internal" href="berkeleytime/berkeleytime.html#module-berkeleytime.views">views.py</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="campus/campus.html">Campus</a><ul>
@@ -172,14 +169,6 @@ <h1>BerkeleyTime<a class="headerlink" href="#berkeleytime" title="Permalink to t
 </li>
 </ul>
 </div>
-<div class="section" id="indices-and-tables">
-<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
-<ul class="simple">
-<li><a class="reference internal" href="../genindex.html"><span class="std std-ref">Index</span></a></li>
-<li><a class="reference internal" href="../py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
-<li><a class="reference internal" href="../search.html"><span class="std std-ref">Search Page</span></a></li>
-</ul>
-</div>
 </div>
 
 
@@ -210,7 +199,6 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="marketplace/marketplace.html">Marketplace</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mondaine/mondaine.html">Mondaine</a></li>
 <li class="toctree-l2"><a class="reference internal" href="scheduler/scheduler.html">Scheduler</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../build/build.html">Build</a></li>

diff --git a/_build/html/berkeleytime/berkeleytime/berkeleytime.html b/_build/html/berkeleytime/berkeleytime/berkeleytime.html
@@ -74,14 +74,6 @@ <h2>urls.py<a class="headerlink" href="#urls-py" title="Permalink to this headli
 <code class="descclassname">berkeleytime.views.</code><code class="descname">test</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#berkeleytime.views.test" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
-<div class="section" id="indices-and-tables">
-<h3>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h3>
-<ul class="simple">
-<li><a class="reference internal" href="../../genindex.html"><span class="std std-ref">Index</span></a></li>
-<li><a class="reference internal" href="../../py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
-<li><a class="reference internal" href="../../search.html"><span class="std std-ref">Search Page</span></a></li>
-</ul>
-</div>
 </div>
 </div>
 
@@ -110,10 +102,7 @@ <h3>Navigation</h3>
 <li class="toctree-l3"><a class="reference internal" href="utils/utils.html">Utils</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#settings-py">settings.py</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#urls-py">urls.py</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#module-berkeleytime.views">views.py</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
-</ul>
-</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-berkeleytime.views">views.py</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../campus/campus.html">Campus</a></li>
@@ -122,7 +111,6 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="../marketplace/marketplace.html">Marketplace</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../mondaine/mondaine.html">Mondaine</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../scheduler/scheduler.html">Scheduler</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../berkeleytime.html#indices-and-tables">Indices and tables</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../build/build.html">Build</a></li>

diff --git a/_build/html/berkeleytime/catalog/catalog.html b/_build/html/berkeleytime/catalog/catalog.html
@@ -1387,7 +1387,6 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="../marketplace/marketplace.html">Marketplace</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../mondaine/mondaine.html">Mondaine</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../scheduler/scheduler.html">Scheduler</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../berkeleytime.html#indices-and-tables">Indices and tables</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../build/build.html">Build</a></li>

diff --git a/_build/html/berkeleytime/catalog/service/service.html b/_build/html/berkeleytime/catalog/service/service.html
@@ -303,16 +303,15 @@ <h3>Navigation</h3>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="../catalog.html#admin-py">admin.py</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../catalog.html#models-py">models.py</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../catalog.html#utils-py">utils.py</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../catalog.html#views-py">views.py</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../catalog.html#module-catalog.models">models.py</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../catalog.html#module-catalog.utils">utils.py</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../catalog.html#module-catalog.views">views.py</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../../data/data.html">Data</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../marketplace/marketplace.html">Marketplace</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../mondaine/mondaine.html">Mondaine</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scheduler/scheduler.html">Scheduler</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../berkeleytime.html#indices-and-tables">Indices and tables</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../../build/build.html">Build</a></li>

diff --git a/_build/html/berkeleytime/marketplace/job/job.html b/_build/html/berkeleytime/marketplace/job/job.html
@@ -83,7 +83,6 @@ <h3>Navigation</h3>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../../mondaine/mondaine.html">Mondaine</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../scheduler/scheduler.html">Scheduler</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../berkeleytime.html#indices-and-tables">Indices and tables</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../../build/build.html">Build</a></li>

diff --git a/_build/html/berkeleytime/marketplace/marketplace.html b/_build/html/berkeleytime/marketplace/marketplace.html
@@ -295,7 +295,6 @@ <h3>Navigation</h3>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../mondaine/mondaine.html">Mondaine</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../scheduler/scheduler.html">Scheduler</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../berkeleytime.html#indices-and-tables">Indices and tables</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../build/build.html">Build</a></li>

diff --git a/_build/html/build/build.html b/_build/html/build/build.html
@@ -38,14 +38,6 @@
 <h1>Build<a class="headerlink" href="#build" title="Permalink to this headline">¶</a></h1>
 <div class="toctree-wrapper compound">
 </div>
-<div class="section" id="indices-and-tables">
-<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
-<ul class="simple">
-<li><a class="reference internal" href="../genindex.html"><span class="std std-ref">Index</span></a></li>
-<li><a class="reference internal" href="../py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
-<li><a class="reference internal" href="../search.html"><span class="std std-ref">Search Page</span></a></li>
-</ul>
-</div>
 </div>
 
 
@@ -68,8 +60,7 @@ <h3>Navigation</h3>
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../berkeleytime/berkeleytime.html">BerkeleyTime</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Build</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Build</a><ul class="simple">
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../frontend/frontend.html">Frontend</a></li>

diff --git a/_build/html/frontend/frontend.html b/_build/html/frontend/frontend.html
@@ -37,14 +37,6 @@
 <h1>Frontend<a class="headerlink" href="#frontend" title="Permalink to this headline">¶</a></h1>
 <div class="toctree-wrapper compound">
 </div>
-<div class="section" id="indices-and-tables">
-<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
-<ul class="simple">
-<li><a class="reference internal" href="../genindex.html"><span class="std std-ref">Index</span></a></li>
-<li><a class="reference internal" href="../py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
-<li><a class="reference internal" href="../search.html"><span class="std std-ref">Search Page</span></a></li>
-</ul>
-</div>
 </div>
 
 
@@ -68,8 +60,7 @@ <h3>Navigation</h3>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../berkeleytime/berkeleytime.html">BerkeleyTime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../build/build.html">Build</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Frontend</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Frontend</a><ul class="simple">
 </ul>
 </li>
 </ul>

diff --git a/_build/html/index.html b/_build/html/index.html
@@ -59,10 +59,7 @@ <h1>Welcome to berkeleytime’s documentation!<a class="headerlink" href="#welco
 </li>
 <li class="toctree-l3"><a class="reference internal" href="berkeleytime/berkeleytime/berkeleytime.html#settings-py">settings.py</a></li>
 <li class="toctree-l3"><a class="reference internal" href="berkeleytime/berkeleytime/berkeleytime.html#urls-py">urls.py</a></li>
-<li class="toctree-l3"><a class="reference internal" href="berkeleytime/berkeleytime/berkeleytime.html#module-berkeleytime.views">views.py</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="berkeleytime/berkeleytime/berkeleytime.html#indices-and-tables">Indices and tables</a></li>
-</ul>
-</li>
+<li class="toctree-l3"><a class="reference internal" href="berkeleytime/berkeleytime/berkeleytime.html#module-berkeleytime.views">views.py</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="berkeleytime/campus/campus.html">Campus</a><ul>
@@ -170,27 +167,16 @@ <h1>Welcome to berkeleytime’s documentation!<a class="headerlink" href="#welco
 <li class="toctree-l3"><a class="reference internal" href="berkeleytime/scheduler/scheduler.html#views-py">views.py</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="berkeleytime/berkeleytime.html#indices-and-tables">Indices and tables</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="build/build.html">Build</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="build/build.html#indices-and-tables">Indices and tables</a></li>
+<li class="toctree-l1"><a class="reference internal" href="build/build.html">Build</a><ul class="simple">
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="frontend/frontend.html">Frontend</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="frontend/frontend.html#indices-and-tables">Indices and tables</a></li>
+<li class="toctree-l1"><a class="reference internal" href="frontend/frontend.html">Frontend</a><ul class="simple">
 </ul>
 </li>
 </ul>
 </div>
-</div>
-<div class="section" id="indices-and-tables">
-<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
-<ul class="simple">
-<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
-<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
-<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
-</ul>
 </div>
 
 

diff --git a/_build/html/searchindex.js b/_build/html/searchindex.js
diff --git a/berkeleytime/berkeleytime.rst b/berkeleytime/berkeleytime.rst
@@ -12,11 +12,3 @@ BerkeleyTime
    marketplace/marketplace
    mondaine/mondaine
    scheduler/scheduler
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/berkeleytime/berkeleytime/berkeleytime.rst b/berkeleytime/berkeleytime/berkeleytime.rst
@@ -21,10 +21,3 @@ views.py
    :members:
    :undoc-members:
    :show-inheritance:
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/build/build.rst b/build/build.rst
@@ -3,12 +3,3 @@ Build
 
 .. toctree::
    :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/documentation.md b/documentation.md
@@ -0,0 +1,10 @@
+# BerkeleyTime
+### API Documentation
+This is a brief guide to building the HTML pages generated by Sphinx autodoc in the BerkeleyTime  codebase.
+Note: `make html` needs to be run in a Python2 environment.
+  - Enter `berkeleytime/`
+  - Run `make html`
+  - HTML pages will upload to `_build/html/`
+
+
+*BerkeleyTime, 2020*
diff --git a/frontend/frontend.rst b/frontend/frontend.rst
@@ -3,12 +3,3 @@ Frontend
 
 .. toctree::
    :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/frontend/src/views/Login.jsx b/frontend/src/views/Login.jsx
@@ -0,0 +1,26 @@
+import React, { Component } from 'react';
+
+class Login extends Component {
+
+    constructor(props){
+      super(props)
+    }
+
+    onSignIn(googleUser) {
+        var profile = googleUser.getBasicProfile();
+        print('ID: ' + profile.getId()); // Do not send to your backend! Use an ID token instead.
+        print('Name: ' + profile.getName()); //
+        print('Image URL: ' + profile.getImageUrl());
+        print(('Email: ' + profile.getEmail()); // Null if the 'email' scope is not present.
+    }
+
+    render() {
+      return (
+          <script src="https://apis.google.com/js/platform.js" async defer></script>,
+          <meta name="google-signin-client_id" content="YOUR_CLIENT_ID.apps.googleusercontent.com">,
+          <div> Hello </div>,
+          <div> Sign in </div>,
+          <div class="g-signin2" data-onsuccess="onSignIn"></div>
+      )
+    }
+}
diff --git a/index.rst b/index.rst
@@ -12,11 +12,3 @@ Welcome to berkeleytime's documentation!
    berkeleytime/berkeleytime
    build/build
    frontend/frontend
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`