Convert docs to sphinx

This commit is contained in:
Javanaut
2026-06-15 11:14:21 +02:00
parent 12be6e985a
commit 1a11710df7
17 changed files with 1048 additions and 172 deletions

44
docs/conf.py Normal file
View File

@@ -0,0 +1,44 @@
from __future__ import annotations
from importlib.metadata import PackageNotFoundError, version as package_version
from pathlib import Path
import sys
ROOT_DIR = Path(__file__).resolve().parents[1]
SRC_DIR = ROOT_DIR / "src"
sys.path.insert(0, str(SRC_DIR))
project = "FFX"
author = "javanaut@maveno.de"
copyright = "2026, Maveno"
try:
release = package_version("ffx")
except PackageNotFoundError:
release = "0.0.0"
version = release
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
"sphinx_copybutton",
]
source_suffix = {
".rst": "restructuredtext",
}
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
html_theme = "sphinx_rtd_theme"
html_title = "FFX"
html_static_path = []
autodoc_typehints = "description"
autodoc_member_order = "bysource"
napoleon_google_docstring = True
napoleon_numpy_docstring = True