Repository navigation
Expand file tree
/
Copy pathconf.py
More file actions
78 lines (62 loc) · 2.35 KB
/
Copy pathconf.py
File metadata and controls
78 lines (62 loc) · 2.35 KB
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
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'ObjectBox Python API'
copyright = '2024, ObjectBox Ltd.'
author = 'ObjectBox Ltd.'
release = '5.0.0'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.autodoc',
'autoapi.extension',
]
# 'sphinx.ext.inheritance_diagram',
# 'sphinx.ext.autodoc',
# -- autoapi configuration ---------------------------------------------------
# https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html
autoapi_dirs = ['../objectbox']
# autoapi_template_dir = ''
# autoapi_file_patterns = ['*.py', '*.pyi']
# autoapi_generate_api_docs = True
autoapi_options = [
'members',
'inherited-members',
'undoc-members',
# 'private-members',
# 'special-members',
# 'show-inheritance',
# 'show-inheritance-diagram',
'show-module-summary',
'imported-members',
]
# autoapi_ignore = ['*migrations']
# autoapi_root = 'autoapi'
autoapi_add_toctree_entry = False # default: True
autoapi_python_class_content = "both" # default: "class"
# autoapi_member_order = 'bysource'
# autoapi_python_use_implicit_namespaces = False
# autoapi_own_page_level = 'module'
# Advanced:
# autoapi_keep_files = False
# Experimental:
autodoc_typehints = 'description'
only_top_level : bool = True
if only_top_level:
def skip_submodules(app, what, name, obj, skip, options):
if what == "module":
skip = True
elif what == "package" and name != "objectbox":
skip = True
return skip
def setup(sphinx):
sphinx.connect("autoapi-skip-member", skip_submodules)
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_logo = '_static/logo-white-500px.png'