From e593980a33b71779bff3838e4ccfc8fae1ebeba2 Mon Sep 17 00:00:00 2001 From: josh-ashkinaze Date: Sat, 6 Jul 2024 16:43:29 -0400 Subject: [PATCH] update docs --- docs/Makefile | 10 +++++----- docs/agent.rst | 12 ++++++------ docs/conf.py | 30 +++++++----------------------- docs/deliberation.rst | 8 ++++---- docs/helpers.rst | 8 ++++---- docs/index.rst | 11 ++++++++--- docs/make.bat | 38 ++++++++++---------------------------- 7 files changed, 44 insertions(+), 73 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index d4bb2cb..46890a1 100644 --- a/docs/Makefile +++ b/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) diff --git a/docs/agent.rst b/docs/agent.rst index 4d0f6c9..d89f6b0 100644 --- a/docs/agent.rst +++ b/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: diff --git a/docs/conf.py b/docs/conf.py index 0c1c2ea..6f5c08f 100644 --- a/docs/conf.py +++ b/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'] diff --git a/docs/deliberation.rst b/docs/deliberation.rst index a6e5eb8..0a6073d 100644 --- a/docs/deliberation.rst +++ b/docs/deliberation.rst @@ -1,7 +1,7 @@ Deliberation Module =================== -.. automodule:: deliberation - :members: - :undoc-members: - :show-inheritance: +.. automodule:: plurals.deliberation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/helpers.rst b/docs/helpers.rst index 3806cdf..6d95603 100644 --- a/docs/helpers.rst +++ b/docs/helpers.rst @@ -1,7 +1,7 @@ Helpers Module ============== -.. automodule:: helpers - :members: - :undoc-members: - :show-inheritance: +.. automodule:: plurals.helpers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index 77449cd..e74ecf9 100644 --- a/docs/index.rst +++ b/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 ================== diff --git a/docs/make.bat b/docs/make.bat index 954237b..09e17c7 100644 --- a/docs/make.bat +++ b/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