mirror of
https://github.com/angr/pyvex
synced 2026-06-21 13:47:01 +00:00
Kevin Phoenix
55 lines
1.8 KiB
Python
55 lines
1.8 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
|
|
|
|
import datetime
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = "pyvex"
|
|
project_copyright = f"{datetime.datetime.now().year}, The angr Project contributors"
|
|
author = "The angr Project"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx.ext.coverage",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.todo",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx_autodoc_typehints",
|
|
"myst_parser",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
# -- Options for autodoc -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration
|
|
autoclass_content = "class"
|
|
autodoc_default_options = {
|
|
"members": True,
|
|
"member-order": "bysource",
|
|
"show-inheritance": True,
|
|
"special-members": "__init__",
|
|
"undoc-members": True,
|
|
}
|
|
autodoc_inherit_docstrings = True
|
|
autodoc_typehints = "both"
|
|
|
|
# -- Options for coverage ----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/extensions/coverage.html
|
|
coverage_write_headline = False
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "furo"
|
|
html_static_path = ["_static"]
|