feat/OPS-61: add basic documentation

It currently works only for haiku.py for some reason
This commit is contained in:
Joscha Dierks 2025-03-14 16:53:44 +01:00
parent eb9aa864ab
commit 39369a65d6
13 changed files with 145 additions and 2 deletions

35
docs/source/conf.py Normal file
View file

@ -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'