# 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.

import os

import sys

sys.path.insert(0, os.path.abspath('..'))

import diskcache

# -- Project information -----------------------------------------------------

project = 'DiskCache'

copyright = '2023, Grant Jenks'

author = 'Grant Jenks'

# The full version, including alpha/beta/rc tags

release = diskcache.__version__

# -- 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.todo',

]

# 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'

# Theme options are theme-specific and customize the look and feel of a theme

# further. For a list of options available for each theme, see the

# documentation.

html_theme_options = {

'logo': 'gj-logo.png',

'logo_name': True,

'logo_text_align': 'center',

'analytics_id': 'UA-19364636-2',

'show_powered_by': False,

'show_related': True,

'github_user': 'grantjenks',

'github_repo': 'python-diskcache',

'github_type': 'star',

}

# 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']

# Custom sidebar templates, maps document names to template names.

html_sidebars = {

'**': [

'about.html',

'gumroad.html',

'localtoc.html',

'relations.html',

'searchbox.html',

]

}

def setup(app):

app.add_css_file('custom.css')