for testing and deploying your application
for finding and fixing issues
for empowering human code reviews
"""
Sphinx config file for Tyrannosaurus.
Uses several extensions to get API docs and sourcecode.
https://www.sphinx-doc.org/en/master/usage/configuration.html
from pathlib import Path
import tomlkit
root = Path(__file__).parent.parent.absolute()
toml = tomlkit.loads((root / "pyproject.toml").read_text(encoding="utf8"))
def find(key: str) -> str:
return str(toml["tool"]["poetry"][key])
language = None
project = find("name")
version = find("version")
release = find("version")
author = ", ".join(find("authors"))
copyright = "Copyright (2020)"
extensions = [
"autoapi.extension",
"sphinx.ext.napoleon",
"sphinx_rtd_theme",
"sphinxcontrib.mermaid",
]
autoapi_type = "python"
autoapi_dirs = [str(root / project)]
master_doc = "index"
exclude_patterns = ["_build", "Thumbs.db", ".*", "~*", "*~", "*#"]
html_theme = "sphinx_rtd_theme"