conf.py

"""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 sys
from pathlib import Path

sys.path.insert(0, str(Path("..").resolve()))
import flake8_async

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "flake8-async"
# A001: shadowing python builtin
copyright = "2024, Zac Hatfield-Dodds, John Litborn, and Contributors"  # noqa: A001
author = "Zac Hatfield-Dodds, John Litborn, and Contributors"


version = flake8_async.__version__
release = version

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions: list[str] = []

templates_path = ["_templates"]
exclude_patterns: list[str] = ["_build", "Thumbs.db", ".DS_Store"]

# Warn about all references to unknown targets
nitpicky = True


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "alabaster"
# We don't currently use the _static directory, and git doesn't allow empty directories,
# so leaving it commented out for now to silence a warning.
# `html_static_path = ["_static"]`