|
13 | 13 | # If extensions (or modules to document with autodoc) are in another directory,
|
14 | 14 | # add these directories to sys.path here. If the directory is relative to the
|
15 | 15 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
16 |
| - |
17 |
| -sys.path.insert(0, os.path.join(os.path.abspath('..'), 'src')) |
| 16 | +sys.path.insert(0, os.path.join(os.path.abspath(".."), "src")) |
18 | 17 |
|
19 | 18 |
|
20 | 19 | # -- Project information -----------------------------------------------------
|
21 | 20 |
|
22 |
| -project = 'websockets' |
23 |
| -copyright = f'2013-{datetime.date.today().year}, Aymeric Augustin and contributors' |
24 |
| -author = 'Aymeric Augustin' |
| 21 | +project = "websockets" |
| 22 | +copyright = f"2013-{datetime.date.today().year}, Aymeric Augustin and contributors" |
| 23 | +author = "Aymeric Augustin" |
25 | 24 |
|
26 | 25 | # The full version, including alpha/beta/rc tags
|
27 |
| -release = '9.1' |
| 26 | +release = "9.1" |
28 | 27 |
|
29 | 28 |
|
30 | 29 | # -- General configuration ---------------------------------------------------
|
|
33 | 32 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
34 | 33 | # ones.
|
35 | 34 | extensions = [
|
36 |
| - 'sphinx.ext.autodoc', |
37 |
| - 'sphinx.ext.intersphinx', |
38 |
| - 'sphinx.ext.viewcode', |
39 |
| - 'sphinx_autodoc_typehints', |
40 |
| - 'sphinxcontrib.spelling', |
41 |
| - 'sphinxcontrib_trio', |
| 35 | + "sphinx.ext.autodoc", |
| 36 | + "sphinx.ext.intersphinx", |
| 37 | + "sphinx.ext.viewcode", |
| 38 | + "sphinx_autodoc_typehints", |
| 39 | + "sphinxcontrib.spelling", |
| 40 | + "sphinxcontrib_trio", |
42 | 41 | ]
|
43 | 42 |
|
44 |
| -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} |
| 43 | +intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} |
45 | 44 |
|
46 | 45 | # Add any paths that contain templates here, relative to this directory.
|
47 |
| -templates_path = ['_templates'] |
| 46 | +templates_path = ["_templates"] |
48 | 47 |
|
49 | 48 | # List of patterns, relative to source directory, that match files and
|
50 | 49 | # directories to ignore when looking for source files.
|
51 | 50 | # This pattern also affects html_static_path and html_extra_path.
|
52 |
| -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 51 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
53 | 52 |
|
54 | 53 |
|
55 | 54 | # -- Options for HTML output -------------------------------------------------
|
56 | 55 |
|
57 | 56 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
58 | 57 | # a list of builtin themes.
|
59 |
| -# |
60 |
| -html_theme = 'alabaster' |
| 58 | +html_theme = "alabaster" |
61 | 59 |
|
62 | 60 | html_theme_options = {
|
63 |
| - 'logo': 'websockets.svg', |
64 |
| - 'description': 'A library for building WebSocket servers and clients in Python with a focus on correctness and simplicity.', |
65 |
| - 'github_button': True, |
66 |
| - 'github_type': 'star', |
67 |
| - 'github_user': 'aaugustin', |
68 |
| - 'github_repo': 'websockets', |
69 |
| - 'tidelift_url': 'https://tidelift.com/subscription/pkg/pypi-websockets?utm_source=pypi-websockets&utm_medium=referral&utm_campaign=docs', |
| 61 | + "logo": "websockets.svg", |
| 62 | + "description": "A library for building WebSocket servers and clients in Python with a focus on correctness and simplicity.", |
| 63 | + "github_button": True, |
| 64 | + "github_type": "star", |
| 65 | + "github_user": "aaugustin", |
| 66 | + "github_repo": "websockets", |
| 67 | + "tidelift_url": "https://tidelift.com/subscription/pkg/pypi-websockets?utm_source=pypi-websockets&utm_medium=referral&utm_campaign=docs", |
70 | 68 | }
|
71 | 69 |
|
72 | 70 | html_sidebars = {
|
73 |
| - '**': [ |
74 |
| - 'about.html', |
75 |
| - 'searchbox.html', |
76 |
| - 'navigation.html', |
77 |
| - 'relations.html', |
78 |
| - 'donate.html', |
| 71 | + "**": [ |
| 72 | + "about.html", |
| 73 | + "searchbox.html", |
| 74 | + "navigation.html", |
| 75 | + "relations.html", |
| 76 | + "donate.html", |
79 | 77 | ]
|
80 | 78 | }
|
81 | 79 |
|
82 | 80 | # Add any paths that contain custom static files (such as style sheets) here,
|
83 | 81 | # relative to this directory. They are copied after the builtin static files,
|
84 | 82 | # so a file named "default.css" will overwrite the builtin "default.css".
|
85 |
| -html_static_path = ['_static'] |
| 83 | +html_static_path = ["_static"] |
0 commit comments