mirror of
https://github.com/release-engineering/repo-autoindex.git
synced 2025-02-23 13:42:52 +00:00
efb595d624
This library includes inline type hints, but per PEP 561 this must be indicated by including a "py.typed" marker file, otherwise tools like mypy will not make use of the type hints when checking downstream projects.
46 lines
1.4 KiB
Python
46 lines
1.4 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
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = "repo-autoindex"
|
|
copyright = "2023, Red Hat"
|
|
author = "Rohan McGovern <rmcgover@redhat.com>"
|
|
release = "1.1.2"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.githubpages",
|
|
"sphinx.ext.napoleon",
|
|
"sphinxarg.ext",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
|
|
# -- 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"]
|
|
|
|
html_theme_options = {
|
|
# Disable showing the sidebar. Defaults to 'false'
|
|
"nosidebar": True,
|
|
}
|
|
|
|
|
|
# -- Options for intersphinx extension ---------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration
|
|
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3", None),
|
|
}
|