73 lines
2.4 KiB
Python
73 lines
2.4 KiB
Python
from pathlib import Path
|
|
import sys
|
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
BASE_DIR = Path(__file__).resolve().parent
|
|
sys.path.insert(0, BASE_DIR / '..')
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'twtxt-registry-client'
|
|
copyright = '2019, Lucidiot'
|
|
author = 'Lucidiot'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
with (BASE_DIR / '..' / 'VERSION').open() as f:
|
|
release = f.read().strip()
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.coverage',
|
|
'sphinx.ext.viewcode',
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = 'alabaster'
|
|
html_theme_options = {
|
|
'description': 'API client and CLI for twtxt registries',
|
|
'fixed_sidebar': 'true',
|
|
}
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
# html_static_path = ['_static']
|
|
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
|
|
# Concatenate the class' and __init__'s docstrings when documenting a class
|
|
autoclass_content = 'both'
|