amaranth/docs/conf.py
2023-02-17 09:59:19 +00:00

38 lines
878 B
Python

import os, sys
sys.path.insert(0, os.path.abspath("."))
import amaranth
project = "Amaranth HDL toolchain"
version = amaranth.__version__
release = version.split("+")[0]
copyright = "2020—2023, Amaranth HDL developers"
extensions = [
"sphinx.ext.intersphinx",
"sphinx.ext.doctest",
"sphinx.ext.todo",
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_rtd_theme",
"sphinxcontrib.platformpicker",
]
with open(".gitignore") as f:
exclude_patterns = [line.strip() for line in f.readlines()]
root_doc = "cover"
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
todo_include_todos = True
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_use_ivar = True
napoleon_custom_sections = ["Platform overrides"]
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
html_css_files = ["custom.css"]