From ebffdb1b566151c04e6b249c4647fa2079a53872 Mon Sep 17 00:00:00 2001 From: ethanlchristensen Date: Tue, 5 Nov 2024 19:30:21 -0600 Subject: [PATCH] erm --- .gitignore | 1 - docs/Makefile | 20 ++++ docs/make.bat | 35 ++++++ docs/source/bruhanimate.bruheffect.rst | 133 +++++++++++++++++++++++ docs/source/bruhanimate.bruhrenderer.rst | 61 +++++++++++ docs/source/bruhanimate.bruhutil.rst | 61 +++++++++++ docs/source/bruhanimate.demos.rst | 133 +++++++++++++++++++++++ docs/source/bruhanimate.rst | 21 ++++ docs/source/conf.py | 36 ++++++ docs/source/index.rst | 17 +++ docs/source/modules.rst | 7 ++ 11 files changed, 524 insertions(+), 1 deletion(-) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/bruhanimate.bruheffect.rst create mode 100644 docs/source/bruhanimate.bruhrenderer.rst create mode 100644 docs/source/bruhanimate.bruhutil.rst create mode 100644 docs/source/bruhanimate.demos.rst create mode 100644 docs/source/bruhanimate.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/modules.rst diff --git a/.gitignore b/.gitignore index 7ec5ff4..fa3b8d7 100644 --- a/.gitignore +++ b/.gitignore @@ -175,7 +175,6 @@ Terms Privacy Security Status -Docs Contact GitHub Pricing API diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# 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 +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.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). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..dc1312a --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +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" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/bruhanimate.bruheffect.rst b/docs/source/bruhanimate.bruheffect.rst new file mode 100644 index 0000000..b3a3945 --- /dev/null +++ b/docs/source/bruhanimate.bruheffect.rst @@ -0,0 +1,133 @@ +bruhanimate.bruheffect package +============================== + +Submodules +---------- + +bruhanimate.bruheffect.audio\_effect module +------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.audio_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.base\_effect module +------------------------------------------ + +.. automodule:: bruhanimate.bruheffect.base_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.chatbot\_effect module +--------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.chatbot_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.draw\_lines\_effect module +------------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.draw_lines_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.firework\_effect module +---------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.firework_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.game\_of\_life\_effect module +---------------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.game_of_life_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.matrix\_effect module +-------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.matrix_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.noise\_effect module +------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.noise_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.offset\_effect module +-------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.offset_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.plasma\_effect module +-------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.plasma_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.rain\_effect module +------------------------------------------ + +.. automodule:: bruhanimate.bruheffect.rain_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.snow\_effect module +------------------------------------------ + +.. automodule:: bruhanimate.bruheffect.snow_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.star\_effect module +------------------------------------------ + +.. automodule:: bruhanimate.bruheffect.star_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.static\_effect module +-------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.static_effect + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruheffect.twinkle\_effect module +--------------------------------------------- + +.. automodule:: bruhanimate.bruheffect.twinkle_effect + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bruhanimate.bruheffect + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bruhanimate.bruhrenderer.rst b/docs/source/bruhanimate.bruhrenderer.rst new file mode 100644 index 0000000..01dbc49 --- /dev/null +++ b/docs/source/bruhanimate.bruhrenderer.rst @@ -0,0 +1,61 @@ +bruhanimate.bruhrenderer package +================================ + +Submodules +---------- + +bruhanimate.bruhrenderer.background\_color\_renderer module +----------------------------------------------------------- + +.. automodule:: bruhanimate.bruhrenderer.background_color_renderer + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruhrenderer.base\_renderer module +---------------------------------------------- + +.. automodule:: bruhanimate.bruhrenderer.base_renderer + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruhrenderer.center\_renderer module +------------------------------------------------ + +.. automodule:: bruhanimate.bruhrenderer.center_renderer + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruhrenderer.effect\_renderer module +------------------------------------------------ + +.. automodule:: bruhanimate.bruhrenderer.effect_renderer + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruhrenderer.focus\_renderer module +----------------------------------------------- + +.. automodule:: bruhanimate.bruhrenderer.focus_renderer + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruhrenderer.pan\_renderer module +--------------------------------------------- + +.. automodule:: bruhanimate.bruhrenderer.pan_renderer + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bruhanimate.bruhrenderer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bruhanimate.bruhutil.rst b/docs/source/bruhanimate.bruhutil.rst new file mode 100644 index 0000000..c6e91ac --- /dev/null +++ b/docs/source/bruhanimate.bruhutil.rst @@ -0,0 +1,61 @@ +bruhanimate.bruhutil package +============================ + +Submodules +---------- + +bruhanimate.bruhutil.bruherrors module +-------------------------------------- + +.. automodule:: bruhanimate.bruhutil.bruherrors + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruhutil.bruhffer module +------------------------------------ + +.. automodule:: bruhanimate.bruhutil.bruhffer + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruhutil.bruhimage module +------------------------------------- + +.. automodule:: bruhanimate.bruhutil.bruhimage + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruhutil.bruhscreen module +-------------------------------------- + +.. automodule:: bruhanimate.bruhutil.bruhscreen + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruhutil.bruhtypes module +------------------------------------- + +.. automodule:: bruhanimate.bruhutil.bruhtypes + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.bruhutil.utils module +--------------------------------- + +.. automodule:: bruhanimate.bruhutil.utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bruhanimate.bruhutil + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bruhanimate.demos.rst b/docs/source/bruhanimate.demos.rst new file mode 100644 index 0000000..9fd32bf --- /dev/null +++ b/docs/source/bruhanimate.demos.rst @@ -0,0 +1,133 @@ +bruhanimate.demos package +========================= + +Submodules +---------- + +bruhanimate.demos.audio\_demo module +------------------------------------ + +.. automodule:: bruhanimate.demos.audio_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.chatbot\_demo module +-------------------------------------- + +.. automodule:: bruhanimate.demos.chatbot_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.firework\_demo module +--------------------------------------- + +.. automodule:: bruhanimate.demos.firework_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.gol\_demo module +---------------------------------- + +.. automodule:: bruhanimate.demos.gol_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.holiday module +-------------------------------- + +.. automodule:: bruhanimate.demos.holiday + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.line\_demo module +----------------------------------- + +.. automodule:: bruhanimate.demos.line_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.matrix\_demo module +------------------------------------- + +.. automodule:: bruhanimate.demos.matrix_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.noise\_demo module +------------------------------------ + +.. automodule:: bruhanimate.demos.noise_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.offset\_demo module +------------------------------------- + +.. automodule:: bruhanimate.demos.offset_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.plasma\_demo module +------------------------------------- + +.. automodule:: bruhanimate.demos.plasma_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.rain\_demo module +----------------------------------- + +.. automodule:: bruhanimate.demos.rain_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.snow\_demo module +----------------------------------- + +.. automodule:: bruhanimate.demos.snow_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.stars\_demo module +------------------------------------ + +.. automodule:: bruhanimate.demos.stars_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.static\_demo module +------------------------------------- + +.. automodule:: bruhanimate.demos.static_demo + :members: + :undoc-members: + :show-inheritance: + +bruhanimate.demos.twinkle\_demo module +-------------------------------------- + +.. automodule:: bruhanimate.demos.twinkle_demo + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bruhanimate.demos + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bruhanimate.rst b/docs/source/bruhanimate.rst new file mode 100644 index 0000000..b88a443 --- /dev/null +++ b/docs/source/bruhanimate.rst @@ -0,0 +1,21 @@ +bruhanimate package +=================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + bruhanimate.bruheffect + bruhanimate.bruhrenderer + bruhanimate.bruhutil + bruhanimate.demos + +Module contents +--------------- + +.. automodule:: bruhanimate + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..43e11fb --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,36 @@ +# 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 + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +import os +import sys +sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath('../..')) +sys.path.insert(0, os.path.abspath('../../bruhanimate')) + + +project = 'bruhanimate' +copyright = '2024, Ethan Christensen' +author = 'Ethan Christensen' + +version = '1.0' +release = '1.0' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon'] + +templates_path = ['_templates'] +exclude_patterns = [] + +language = 'en' + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'sphinx_rtd_theme' +html_static_path = ['_static'] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..573fc3b --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,17 @@ +.. bruhanimate documentation master file, created by + sphinx-quickstart on Sun Nov 3 15:19:21 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +bruhanimate documentation +========================= + +Add your content using ``reStructuredText`` syntax. See the +`reStructuredText `_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..915e4c3 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +bruhanimate +=========== + +.. toctree:: + :maxdepth: 4 + + bruhanimate