update docs

docs/Makefile

@@ -1,10 +1,10 @@
 # Minimal makefile for Sphinx documentation
 #
 
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Plurals
 SOURCEDIR     = .
 BUILDDIR      = _build
 
@@ -15,6 +15,6 @@ help:
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/agent.rst

@@ -1,7 +1,7 @@
-Deliberation Module
-===================
+Agent Module
+============
 
-.. automodule:: agent
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. automodule:: plurals.agent
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/conf.py

@@ -1,37 +1,21 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project = 'plurals'
-copyright = '2024, Joshua Ashkinaze'
-author = 'Joshua Ashkinaze'
-release = '0.1.0-alpha'
+project = 'Plurals'
+author = 'Your Name'
+release = '0.1'
 
 # -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-import os
-import sys
-sys.path.insert(0, os.path.abspath('../plurals'))
-
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
-    'autoapi.extension',
 ]
 
-autoapi_dirs = ['../plurals']
-autoapi_root = 'api'
-
 templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = []
 
 # -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
 html_theme = 'alabaster'
 html_static_path = ['_static']

docs/deliberation.rst

@@ -1,7 +1,7 @@
 Deliberation Module
 ===================
 
-.. automodule:: deliberation
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. automodule:: plurals.deliberation
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/helpers.rst

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

docs/index.rst

@@ -1,13 +1,18 @@
-Documentation
+.. 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!
 ===================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   helpers
-   deliberation
    agent
+   deliberation
+   helpers
 
 Indices and tables
 ==================

docs/make.bat

@@ -1,35 +1,17 @@
 @ECHO OFF
 
-pushd %~dp0
+REM Minimal makefile for Sphinx documentation
+REM
 
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
+REM You can set these variables from the command line.
+set SPHINXOPTS=
+set SPHINXBUILD=sphinx-build
+set SPHINXPROJ=Plurals
 set SOURCEDIR=.
 set BUILDDIR=_build
 
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.https://www.sphinx-doc.org/
-	exit /b 1
+if "%1" == "" (
+    %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+) else (
+    %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
 )
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd