Merge branch 'refs/heads/dev/josh-weile-patch-sphinx'

.gitignore

@@ -155,3 +155,34 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+/docs/_build/html/index.html
+/docs/_build/html/objects.inv
+/docs/_build/html/py-modindex.html
+/docs/_build/html/scratch_tutorial.html
+/docs/_build/html/search.html
+/docs/_build/html/searchindex.js
+/docs/_build/html/tutorial.html
+/docs/_build/html/agent.html
+/docs/_build/html/deliberation.html
+/docs/_build/html/genindex.html
+/docs/_build/html/helpers.html
+/docs/_build/html/.buildinfo
+/docs/_build/html/_sources/agent.rst.txt
+/docs/_build/html/_sources/deliberation.rst.txt
+/docs/_build/html/_sources/helpers.rst.txt
+/docs/_build/html/_sources/index.rst.txt
+/docs/_build/html/_sources/scratch_tutorial.rst.txt
+/docs/_build/html/_sources/tutorial.rst.txt
+/docs/_build/doctrees/agent.doctree
+/docs/_build/doctrees/deliberation.doctree
+/docs/_build/doctrees/environment.pickle
+/docs/_build/doctrees/helpers.doctree
+/docs/_build/doctrees/index.doctree
+/docs/_build/doctrees/introduction.doctree
+/docs/_build/doctrees/quickstart.doctree
+/docs/_build/doctrees/scratch_tutorial.doctree
+/docs/_build/doctrees/structures_and_moderators.doctree
+/docs/_build/doctrees/tutorial.doctree
+/docs/_build/doctrees/using_agents.doctree
+/docs/_build/doctrees/using_moderators.doctree
+/docs/_build/doctrees/using_structures.doctree

docs/agent.rst

@@ -1,7 +1,10 @@
 Agent Module
 ============
 
+.. toctree::
+   :maxdepth: 2
+
 .. automodule:: plurals.agent
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:

docs/conf.py

@@ -1,11 +1,11 @@
 import os
 import sys
+
 sys.path.insert(0, os.path.abspath('..'))
 
 # -- Project information -----------------------------------------------------
 project = 'Plurals'
 author = 'Joshua Ashkinaze'
-release = '0.0.1'
 
 # -- General configuration ---------------------------------------------------
 extensions = [
@@ -19,4 +19,11 @@
 
 # -- Options for HTML output -------------------------------------------------
 html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
+html_static_path = ['_static']
+html_sidebars = {
+   '**': ['sidebar.html', 'sourcelink.html', 'searchbox.html']
+}
+
+
+
+

docs/deliberation.rst

@@ -1,5 +1,7 @@
 Deliberation Module
 ===================
+.. toctree::
+   :maxdepth: 2
 
 .. automodule:: plurals.deliberation
    :members:

docs/helpers.rst

@@ -1,7 +1,9 @@
 Helpers Module
-==============
+===================
+.. toctree::
+   :maxdepth: 2
 
 .. automodule:: plurals.helpers
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:

docs/index.rst

@@ -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`