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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a full list see
# the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- 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
root_dir_path = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
sys.path.append(os.path.join(root_dir_path, "oldmemo"))
# -- Project information -----------------------------------------------------------------
from version import __version__ as __version
import tomllib
from typing import List
with open(os.path.join(root_dir_path, "pyproject.toml"), "rb") as f:
__pyproject = tomllib.load(f)
project: str = __pyproject["project"]["name"]
author: str = __pyproject["project"]["authors"][0]["name"]
copyright: str = f"2025, {author}"
__classifiers: List[str] = __pyproject["project"]["classifiers"]
__tag: str = "unknown"
if "Development Status :: 3 - Alpha" in __classifiers:
__tag = "alpha"
if "Development Status :: 4 - Beta" in __classifiers:
__tag = "beta"
if "Development Status :: 5 - Production/Stable" in __classifiers:
__tag = "stable"
# The short X.Y version
version = __version
# The full version, including alpha/beta/rc tags
release = f"{__version}-{__tag}"
# -- 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.viewcode",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx_autodoc_typehints"
]
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"x3dh": ("https://python-x3dh.readthedocs.io/en/latest/", None),
"doubleratchet": ("https://python-doubleratchet.readthedocs.io/en/latest/", None),
"omemo": ("https://py-omemo.readthedocs.io/en/latest/", None),
"xmlschema": ("https://xmlschema.readthedocs.io/en/latest/", None)
}
# 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 = "sphinx_rtd_theme"
# 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" ]
# -- Autodoc Configuration ---------------------------------------------------------------
# There are a bunch of nitpick warnings related to inherited docstrings
#nitpicky = True
autodoc_typehints = "description"
autodoc_type_aliases = { k: k for k in {
"JSONType"
} }
# https://github.com/sphinx-doc/sphinx/issues/10785
def resolve_type_aliases(app, env, node, contnode):
"""Resolve :class: references to our type aliases as :attr: instead."""
if (
node["refdomain"] == "py"
and node["reftype"] == "class"
and node["reftarget"] in autodoc_type_aliases
):
return app.env.get_domain("py").resolve_xref(
env, node["refdoc"], app.builder, "attr", node["reftarget"], node, contnode
)
def autodoc_skip_member_handler(app, what, name, obj, skip, options):
# Skip private members, i.e. those that start with double underscores but do not end in underscores
if name.startswith("__") and not name.endswith("_"):
return True
# Other fixed names to always skip
if name in { "_abc_impl" }:
return True
# Skip __init__s without documentation. Those are just used for type hints.
if name == "__init__" and obj.__doc__ is None:
return True
return None
def setup(app):
app.connect("autodoc-skip-member", autodoc_skip_member_handler)
app.connect("missing-reference", resolve_type_aliases)
|
