1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
from datetime import datetime
import os
import sys
sys.path.insert(0, os.path.abspath(".."))
import mautrix.fixmodule
mautrix.__optional_imports__ = True
project = "mautrix-python"
copyright = f"{datetime.today().year}, Tulir Asokan"
author = "Tulir Asokan"
release = mautrix.__version__
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.inheritance_diagram",
"sphinx.ext.napoleon",
]
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
autodoc_typehints = "description"
autodoc_member_order = "bysource"
autoclass_content = "class"
autodoc_class_signature = "separated"
autodoc_type_aliases = {
"EventContent": "mautrix.types.EventContent",
"StateEventContent": "mautrix.types.StateEventContent",
"Event": "mautrix.types.Event",
}
autodoc_default_options = {
"special-members": "__init__",
"class-doc-from": "class",
"members": True,
"undoc-members": True,
"show-inheritance": True,
}
napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = True
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"aiohttp": ("https://docs.aiohttp.org/en/stable/", None),
"yarl": ("https://yarl.readthedocs.io/en/stable/", None),
}
|
