PySecretHandshake/docs/source/conf.py

38 lines
1.3 KiB
Python

# SPDX-License-Identifier: MIT
#
# SPDX-Copyright-Text: © 2017 PySecretHandshake contributors (see AUTHORS for more details)
# 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
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
"""Sphinx configuration"""
from typing import List
# pylint: disable=invalid-name
project = "PySecretHandshake"
copyright = "2023, Pedro Ferreira, Gergely Polonkai" # pylint: disable=redefined-builtin
author = "Pedro Ferreira, Gergely Polonkai"
release = "0.1.0"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = ["sphinx.ext.duration", "sphinx.ext.autodoc", "sphinx.ext.autosummary"]
templates_path = ["_templates"]
exclude_patterns: List[str] = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "alabaster"
html_static_path = ["_static"]