diff --git a/.dockerignore b/.dockerignore index 1513c39..0d78105 100644 --- a/.dockerignore +++ b/.dockerignore @@ -68,7 +68,7 @@ coverage.xml *.log # Sphinx documentation -docs/_build/ +requirements/_build/ # PyBuilder target/ diff --git a/.gitignore b/.gitignore index a1db2f1..ed76ffc 100644 --- a/.gitignore +++ b/.gitignore @@ -69,7 +69,7 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ +requirements/_build/ # PyBuilder .pybuilder/ 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/_modules/haiku.rst b/docs/source/_modules/haiku.rst new file mode 100644 index 0000000..6e6e926 --- /dev/null +++ b/docs/source/_modules/haiku.rst @@ -0,0 +1,7 @@ +haiku module +============ + +.. automodule:: haiku + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/_modules/main.rst b/docs/source/_modules/main.rst new file mode 100644 index 0000000..eace87b --- /dev/null +++ b/docs/source/_modules/main.rst @@ -0,0 +1,7 @@ +main module +=========== + +.. automodule:: main + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/_modules/modules.rst b/docs/source/_modules/modules.rst new file mode 100644 index 0000000..d024233 --- /dev/null +++ b/docs/source/_modules/modules.rst @@ -0,0 +1,9 @@ +senju +===== + +.. toctree:: + :maxdepth: 4 + + haiku + main + store_manager diff --git a/docs/source/_modules/store_manager.rst b/docs/source/_modules/store_manager.rst new file mode 100644 index 0000000..aa5fa7f --- /dev/null +++ b/docs/source/_modules/store_manager.rst @@ -0,0 +1,7 @@ +store\_manager module +===================== + +.. automodule:: store_manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/_static/kanji.png b/docs/source/_static/kanji.png new file mode 100644 index 0000000..345f5a5 Binary files /dev/null and b/docs/source/_static/kanji.png differ diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..d018fed --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,35 @@ +# 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 +from pathlib import Path +sys.path.insert(0, os.path.abspath("../../senju")) + +project = 'senju' +copyright = '2025, senju hashirama' +author = 'senju hashirama' +release = 'before the light' +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.napoleon'] + +templates_path = ['_templates'] +exclude_patterns = [] + +autodoc_typehints = 'both' + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'nature' +html_static_path = ['_static'] + +html_favicon = '_static/kanji.png' +html_logo = '_static/kanji.png' \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..9915c68 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,19 @@ +.. senju documentation master file, created by + sphinx-quickstart on Fri Mar 14 15:18:32 2025. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome senju documentation +=================== + +Add your content using ``reStructuredText`` syntax. See the +`reStructuredText `_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + usage + _modules/modules \ No newline at end of file diff --git a/docs/source/usage.rst b/docs/source/usage.rst new file mode 100644 index 0000000..10bcfdf --- /dev/null +++ b/docs/source/usage.rst @@ -0,0 +1,4 @@ +Installation +============ + +Its a docker - it just works diff --git a/docs/requirements.md b/requirements/requirements.md similarity index 100% rename from docs/requirements.md rename to requirements/requirements.md