mirror of
https://github.com/senju1337/senju.git
synced 2025-12-24 07:39:29 +00:00
20855b2117
Important: It seems the sphinx commands only work by entering the virtual environment of senju by copying the command/output of ```poetry env activate``` Inside the env install/update the poetry packages to ensure that you use the correct version of sphinx. Afterward cd into the senju/docs folder and execute auto_docu.sh You can open the docu with ```firefox build/html/index.html```
34 lines
No EOL
1.1 KiB
Python
34 lines
No EOL
1.1 KiB
Python
# 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("../../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' |