• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Configuration file for the Sphinx documentation builder.
2#
3# This file only contains a selection of the most common options. For a full
4# list see the documentation:
5# https://www.sphinx-doc.org/en/master/usage/configuration.html
6
7# -- Path setup --------------------------------------------------------------
8
9# If extensions (or modules to document with autodoc) are in another directory,
10# add these directories to sys.path here. If the directory is relative to the
11# documentation root, use os.path.abspath to make it absolute, like shown here.
12#
13# import os
14# import sys
15# sys.path.insert(0, os.path.abspath('.'))
16
17
18# -- Project information -----------------------------------------------------
19
20project = 'typing'
21copyright = '2021, The Python Typing Team'
22author = 'The Python Typing Team'
23
24
25# -- General configuration ---------------------------------------------------
26
27# Add any Sphinx extension module names here, as strings. They can be
28# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
29# ones.
30extensions = [
31]
32
33# Add any paths that contain templates here, relative to this directory.
34templates_path = ['_templates']
35
36# List of patterns, relative to source directory, that match files and
37# directories to ignore when looking for source files.
38# This pattern also affects html_static_path and html_extra_path.
39exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'venv', 'README.rst']
40
41
42# -- Options for HTML output -------------------------------------------------
43
44# The theme to use for HTML and HTML Help pages.  See the documentation for
45# a list of builtin themes.
46#
47html_theme = 'python_docs_theme'
48
49# Add any paths that contain custom static files (such as style sheets) here,
50# relative to this directory. They are copied after the builtin static files,
51# so a file named "default.css" will overwrite the builtin "default.css".
52html_static_path = []
53
54extensions = ['sphinx.ext.intersphinx']
55intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
56