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
|
# 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
this_file_path = os.path.dirname(os.path.abspath(__file__))
sys.path.append(os.path.join(this_file_path, "..", "doubleratchet"))
from version import __version__ as __version
from project import project as __project
# -- Project information -----------------------------------------------------------------
project = __project["name"]
author = __project["author"]
copyright = f"{__project['year']}, {__project['author']}"
# The short X.Y version
version = __version["short"]
# The full version, including alpha/beta/rc tags
release = __version["full"]
# -- 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_autodoc_typehints"
]
# 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 ---------------------------------------------------------------
# The following two options seem to be ignored...
autodoc_typehints = "description"
autodoc_type_aliases = { type_alias: f"{type_alias}" for type_alias in {
"JSONObject"
} }
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
# Could be achieved using exclude-members, but this is more comfy
if name in {
"__abstractmethods__",
"__dict__",
"__module__",
"__new__",
"__weakref__",
"_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)
|
