deploy: 2e9f2be

josh-ashkinaze · Sep 23, 2024 · e7df95e · e7df95e
1 parent d17535e
commit e7df95e
Show file tree

Hide file tree

Showing 21 changed files with 2,553 additions and 65 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d308b23d05c9f9cebb336f96a4d2c135
+config: 561a07fd8cbd02c3812b2c313360cc9d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_modules/index.html b/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; Plurals 0.0.1 documentation</title>
+  <title>Overview: module code &mdash; Plurals  documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="../_static/documentation_options.js?v=5929fcd5"></script>
         <script src="../_static/doctools.js?v=9a2dae69"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>
@@ -41,7 +41,15 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Core Concepts</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorial.html#quick-start-guide">Quick Start Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorial.html#id1">Agents</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorial.html#id2">Structures</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorial.html#id8">Moderators</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../agent.html">Agent Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../deliberation.html">Deliberation Module</a></li>

diff --git a/_modules/plurals/agent.html b/_modules/plurals/agent.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plurals.agent &mdash; Plurals 0.0.1 documentation</title>
+  <title>plurals.agent &mdash; Plurals  documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
 
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -41,7 +41,15 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html">Core Concepts</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#quick-start-guide">Quick Start Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#id1">Agents</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#id2">Structures</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#id8">Moderators</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../agent.html">Agent Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../deliberation.html">Deliberation Module</a></li>

diff --git a/_modules/plurals/deliberation.html b/_modules/plurals/deliberation.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plurals.deliberation &mdash; Plurals 0.0.1 documentation</title>
+  <title>plurals.deliberation &mdash; Plurals  documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
 
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -41,7 +41,15 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html">Core Concepts</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#quick-start-guide">Quick Start Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#id1">Agents</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#id2">Structures</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#id8">Moderators</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../agent.html">Agent Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../deliberation.html">Deliberation Module</a></li>

diff --git a/_modules/plurals/helpers.html b/_modules/plurals/helpers.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plurals.helpers &mdash; Plurals 0.0.1 documentation</title>
+  <title>plurals.helpers &mdash; Plurals  documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
 
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -41,7 +41,15 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html">Core Concepts</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#quick-start-guide">Quick Start Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#id1">Agents</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#id2">Structures</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#id8">Moderators</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../agent.html">Agent Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../deliberation.html">Deliberation Module</a></li>

diff --git a/_sources/agent.rst.txt b/_sources/agent.rst.txt
@@ -1,7 +1,10 @@
 Agent Module
 ============
 
+.. toctree::
+   :maxdepth: 2
+
 .. automodule:: plurals.agent
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
diff --git a/_sources/deliberation.rst.txt b/_sources/deliberation.rst.txt
@@ -1,5 +1,7 @@
 Deliberation Module
 ===================
+.. toctree::
+   :maxdepth: 2
 
 .. automodule:: plurals.deliberation
    :members:

diff --git a/_sources/helpers.rst.txt b/_sources/helpers.rst.txt
@@ -1,7 +1,9 @@
 Helpers Module
-==============
+===================
+.. toctree::
+   :maxdepth: 2
 
 .. automodule:: plurals.helpers
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -1,14 +1,26 @@
-.. Plurals documentation master file, created by
-   sphinx-quickstart on Wed Jul  7 14:29:58 2024.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to Plurals's documentation!
+Welcome to Plurals docs!
 ===================================
 
+.. image:: ../../../assets/figure1.png
+   :alt: Alternative text
+   :scale: 100 %
+
+There are essentially two parts to this documentation. The first is a set of tutorials, which includes a bunch of examples.
+And the second is the lower-level API documentation.
+
+Because we very recently released this package, there may be: (1) things you would like to be more clearly documented or (2)
+things you want to do but this cannot do. We have issue templates for feature requests and documentation requests `here <https://github.com/josh-ashkinaze/plurals/issues/new/choose>`_.
+
+
+.. toctree::
+   :caption: Tutorials
+   :maxdepth: 2
+
+   tutorial
+
 .. toctree::
+   :caption: API Documentation
    :maxdepth: 2
-   :caption: Contents:
 
    agent
    deliberation
@@ -19,4 +31,3 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`