From 8004eb49d0498c3657ab553337f878fe6ca9e9f5 Mon Sep 17 00:00:00 2001 From: BluLupo Date: Tue, 3 Jun 2025 22:59:48 +0200 Subject: [PATCH] Add Sphinx documentation --- docs/Makefile | 20 ++++++++++++++++++++ docs/_static/.gitkeep | 0 docs/_templates/.gitkeep | 0 docs/conf.py | 37 +++++++++++++++++++++++++++++++++++++ docs/index.rst | 11 +++++++++++ docs/make.bat | 35 +++++++++++++++++++++++++++++++++++ docs/modules.rst | 14 ++++++++++++++ requirements.txt | 1 + 8 files changed, 118 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/_static/.gitkeep create mode 100644 docs/_templates/.gitkeep create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat create mode 100644 docs/modules.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /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 = . +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/_static/.gitkeep b/docs/_static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/_templates/.gitkeep b/docs/_templates/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..4164565 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,37 @@ +import os, sys +sys.path.insert(0, os.path.abspath("..")) +# 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 + +project = 'Hersel.it' +copyright = '2025, Hersel Giannella' +author = 'Hersel Giannella' + +version = '0.1' +release = '0.1' + +# -- 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 = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- 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'] +language = 'it' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..07ee83b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,11 @@ +Welcome to Hersel.it's documentation! +==================================== + +Questo progetto è una semplice applicazione web basata su `Quart`. +La documentazione è generata utilizzando Sphinx. + +.. toctree:: + :maxdepth: 2 + :caption: Contenuti: + + modules diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..32bb245 --- /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=. +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/modules.rst b/docs/modules.rst new file mode 100644 index 0000000..3f6fff0 --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,14 @@ +Project Modules +=============== + +.. automodule:: app + :members: + :undoc-members: + +.. automodule:: config + :members: + :undoc-members: + +.. automodule:: routes.home + :members: + :undoc-members: diff --git a/requirements.txt b/requirements.txt index dbd0e45..e3e176b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -21,3 +21,4 @@ typing_extensions==4.12.2 Werkzeug==3.1.3 wsproto==1.2.0 httpx==0.27.0 +Sphinx==8.2.3