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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
# Configuration file for the Sphinx documentation builder.
# ruff: noqa: FIX002
from __future__ import annotations
import datetime
import os
import warnings
from functools import partial
from typing import TYPE_CHECKING, Any
from sqlalchemy.exc import SAWarning
from advanced_alchemy.__metadata__ import __project__, __version__
if TYPE_CHECKING:
from typing import Any
from sphinx.addnodes import document # type: ignore[attr-defined,unused-ignore]
from sphinx.application import Sphinx
# -- Environmental Data ------------------------------------------------------
warnings.filterwarnings("ignore", category=SAWarning)
# -- Project information -----------------------------------------------------
current_year = datetime.datetime.now().year # noqa: DTZ005
project = __project__
copyright = f"{current_year}, Litestar Organization" # noqa: A001
release = os.getenv("_ADVANCED-ALCHEMY_DOCS_BUILD_VERSION", __version__.rsplit(".")[0])
suppress_warnings = [
"autosectionlabel.*",
"ref.python", # TODO: remove when https://github.com/sphinx-doc/sphinx/issues/4961 is fixed
]
# -- General configuration ---------------------------------------------------
extensions = [
"sphinx.ext.intersphinx",
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.autosectionlabel",
"sphinx.ext.githubpages",
"sphinx.ext.viewcode",
"tools.sphinx_ext.missing_references",
"tools.sphinx_ext.changelog",
"sphinx_autodoc_typehints",
"myst_parser",
"auto_pytabs.sphinx_ext",
"sphinx_copybutton",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx_click",
"sphinx_toolbox.collapse",
"sphinx_design",
"sphinx_togglebutton",
"sphinx_paramlinks",
]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"msgspec": ("https://jcristharif.com/msgspec/", None),
"sqlalchemy": ("https://docs.sqlalchemy.org/en/20/", None),
"alembic": ("https://alembic.sqlalchemy.org/en/latest/", None),
"litestar": ("https://docs.litestar.dev/latest/", None),
"click": ("https://click.palletsprojects.com/en/stable/", None),
"anyio": ("https://anyio.readthedocs.io/en/stable/", None),
"multidict": ("https://multidict.aio-libs.org/en/stable/", None),
"cryptography": ("https://cryptography.io/en/latest/", None),
"pydantic": ("https://docs.pydantic.dev/latest/", None),
"sanic": ("https://sanic.readthedocs.io/en/latest/", None),
"flask": ("https://flask.palletsprojects.com/en/stable/", None),
"typing_extensions": ("https://typing-extensions.readthedocs.io/en/stable/", None),
}
PY_CLASS = "py:class"
PY_EXC = "py:exc"
PY_RE = r"py:.*"
PY_METH = "py:meth"
PY_ATTR = "py:attr"
PY_OBJ = "py:obj"
PY_FUNC = "py:func"
nitpicky = True
nitpick_ignore: list[str] = []
nitpick_ignore_regex: list[str] = []
auto_pytabs_min_version = (3, 9)
auto_pytabs_max_version = (3, 13)
napoleon_google_docstring = True
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = True
napoleon_use_admonition_for_notes = True
napoleon_use_admonition_for_references = False
napoleon_attr_annotations = True
autoclass_content = "class"
autodoc_class_signature = "separated"
autodoc_default_options = {"special-members": "__init__", "show-inheritance": True, "members": True}
autodoc_member_order = "bysource"
autodoc_typehints_format = "short"
autodoc_type_aliases = {
"ModelT": "advanced_alchemy.repository.typing.ModelT",
"FilterTypeT": "advanced_alchemy.filters.FilterTypeT",
"StatementTypeT": "advanced_alchemy.filters.StatementTypeT",
"EngineT": "sqlalchemy.engine.Engine",
"AsyncEngineT": "sqlalchemy.ext.asyncio.AsyncEngine",
"SessionT": "sqlalchemy.orm.Session",
"AsyncSessionT": "sqlalchemy.ext.asyncio.AsyncSession",
"ConnectionT": "sqlalchemy.engine.Connection",
"AsyncConnectionT": "sqlalchemy.ext.asyncio.AsyncConnection",
"Mapper": "sqlalchemy.orm.Mapper",
"Registry": "sqlalchemy.orm.registry",
"RegistryType": "sqlalchemy.orm.registry",
"Table": "sqlalchemy.schema.Table",
"MetaData": "sqlalchemy.schema.MetaData",
"FilterableRepository": "advanced_alchemy.repository._util.FilterableRepository",
"SQLAlchemyAsyncRepositoryProtocol": "advanced_alchemy.repository._async.SQLAlchemyAsyncRepositoryProtocol",
"SQLAlchemyAsyncRepository": "advanced_alchemy.repository.SQLAlchemyAsyncRepository",
"SQLAlchemySyncRepositoryProtocol": "advanced_alchemy.repository._sync.SQLAlchemySyncRepositoryProtocol",
"SQLAlchemySyncRepository": "advanced_alchemy.repository.SQLAlchemySyncRepository",
"SQLAlchemyAsyncSlugRepositoryProtocol": "advanced_alchemy.repository._async.SQLAlchemyAsyncSlugRepositoryProtocol",
"SQLAlchemySyncSlugRepositoryProtocol": "advanced_alchemy.repository._sync.SQLAlchemySyncSlugRepositoryProtocol",
"ModelOrRowMappingT": "advanced_alchemy.repository.ModelOrRowMappingT",
"ModelDTOT": "advanced_alchemy.service.ModelDTOT",
"DTOData": "litestar.dto.data_structures.DTOData",
"InstrumentedAttribute": "sqlalchemy.orm.attributes.InstrumentedAttribute",
"BaseModel": "pydantic.BaseModel",
"Struct": "msgspec.Struct",
"TableArgsType": "sqlalchemy.orm.decl_base._TableArgsType",
"DateTimeUTC": "advanced_alchemy.types.DateTimeUTC",
"TypeEngine": "sqlalchemy.types.TypeEngine",
"DeclarativeBase": "sqlalchemy.orm.DeclarativeBase",
"UUIDBase": "advanced_alchemy.base.UUIDBase",
"NanoIDBase": "advanced_alchemy.base.NanoIDBase",
"BigIntBase": "advanced_alchemy.base.BigIntBase",
"BigIntAuditBase": "advanced_alchemy.base.BigIntAuditBase",
"DefaultBase": "advanced_alchemy.base.DefaultBase",
"SQLQuery": "advanced_alchemy.base.SQLQuery",
"UUIDv6PrimaryKey": "advanced_alchemy.base.UUIDv6PrimaryKey",
"UUIDv7PrimaryKey": "advanced_alchemy.base.UUIDv7PrimaryKey",
"NanoIDPrimaryKey": "advanced_alchemy.base.NanoIDPrimaryKey",
"BigIntPrimaryKey": "advanced_alchemy.base.BigIntPrimaryKey",
"CommonTableAttributes": "advanced_alchemy.base.CommonTableAttributes",
"AuditColumns": "advanced_alchemy.base.AuditColumns",
"UUIDPrimaryKey": "advanced_alchemy.base.UUIDPrimaryKey",
"EngineConfig": "advanced_alchemy.config.EngineConfig",
"AsyncSessionConfig": "advanced_alchemy.config.AsyncSessionConfig",
"SyncSessionConfig": "advanced_alchemy.config.SyncSessionConfig",
"EmptyType": "advanced_alchemy.utils.dataclass.EmptyType",
"async_sessionmaker": "sqlalchemy.ext.asyncio.async_sessionmaker",
"sessionmaker": "sqlalchemy.orm.sessionmaker",
"SlugMixin": "advanced_alchemy.mixins.slug.SlugKey",
"UniqueMixin": "advanced_alchemy.mixins.unique.UniqueMixin",
"AsyncEngine": "sqlalchemy.ext.asyncio.AsyncEngine",
"Engine": "sqlalchemy.engine.Engine",
"sqlalchemy": "sqlalchemy",
"RenameStrategy": "litestar.dto.types.RenameStrategy",
"Union": "typing.Union",
"Callable": "typing.Callable",
"Any": "typing.Any",
"Optional": "typing.Optional",
"_EchoFlagType": "advanced_alchemy.config._EchoFlagType",
"advanced_alchemy.types.encrypted_string.PGCryptoBackend": "advanced_alchemy.types.encrypted_string.PGCryptoBackend",
"advanced_alchemy.types.password_hash.pwdlib.PwdlibHasher": "advanced_alchemy.types.password_hash.pwdlib.PwdlibHasher",
"advanced_alchemy.types.password_hash.argon2.Argon2Hasher": "advanced_alchemy.types.password_hash.argon2.Argon2Hasher",
"advanced_alchemy.types.password_hash.passlib.PasslibHasher": "advanced_alchemy.types.password_hash.passlib.PasslibHasher",
}
autodoc_mock_imports = [
"alembic",
"sanic_ext.Extend",
"sanic",
"sqlalchemy.ext.asyncio.engine.create_async_engine",
"_sa.create_engine._sphinx_paramlinks_creator",
"sqlalchemy.Dialect",
"sqlalchemy.orm.MetaData",
# Add these new entries:
"advanced_alchemy.config.engine.EngineConfig",
"advanced_alchemy.config.asyncio.AsyncSessionConfig",
"advanced_alchemy.config.sync.SyncSessionConfig",
"advanced_alchemy.utils.dataclass.EmptyType",
"advanced_alchemy.extensions.litestar.plugins.init.config.engine.EngineConfig",
"sqlalchemy.ext.asyncio",
"sqlalchemy.engine",
"sqlalchemy.orm",
"advanced_alchemy.types.encrypted_string.PGCryptoBackend",
"advanced_alchemy.types.password_hash.pwdlib.PwdlibHasher",
"advanced_alchemy.types.password_hash.argon2.Argon2Hasher",
"advanced_alchemy.types.password_hash.passlib.PasslibHasher",
]
autosectionlabel_prefix_document = True
# Strip the dollar prompt when copying code
# https://sphinx-copybutton.readthedocs.io/en/latest/use.html#strip-and-configure-input-prompts-for-code-cells
copybutton_prompt_text = "$ "
# -- Style configuration -----------------------------------------------------
html_theme = "shibuya"
html_title = "Advanced Alchemy"
html_short_title = "AA"
pygments_style = "dracula"
todo_include_todos = True
html_static_path = ["_static"]
html_favicon = "_static/favicon.png"
templates_path = ["_templates"]
html_js_files = ["versioning.js"]
html_css_files = ["custom.css"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "PYPI_README.md"]
html_show_sourcelink = True
html_copy_source = True
html_context = {
"source_type": "github",
"source_user": "litestar-org",
"source_repo": "advanced-alchemy",
"current_version": "latest",
"version": release,
}
html_theme_options = {
"logo_target": "/",
"accent_color": "amber",
"github_url": "https://github.com/litestar-org/advanced-alchemy",
"discord_url": "https://discord.gg/dSDXd4mKhp",
"navigation_with_keys": True,
"globaltoc_expand_depth": 2,
"light_logo": "_static/logo-default.png",
"dark_logo": "_static/logo-default.png",
"discussion_url": "https://discord.gg/dSDXd4mKhp",
"nav_links": [
{"title": "Home", "url": "index"},
{
"title": "About",
"children": [
{
"title": "Changelog",
"url": "changelog",
"summary": "All changes for Advanced Alchemy",
},
{
"title": "Litestar Organization",
"summary": "Details about the Litestar organization, the team behind Advanced Alchemy",
"url": "https://litestar.dev/about/organization",
"icon": "org",
},
{
"title": "Releases",
"summary": "Explore the release process, versioning, and deprecation policy for Advanced Alchemy",
"url": "releases",
"icon": "releases",
},
{
"title": "Contributing",
"summary": "Learn how to contribute to the Advanced Alchemy project",
"url": "contribution-guide",
"icon": "contributing",
},
{
"title": "Code of Conduct",
"summary": "Review the etiquette for interacting with the Advanced Alchemy community",
"url": "https://github.com/litestar-org/.github?tab=coc-ov-file",
"icon": "coc",
},
{
"title": "Security",
"summary": "Overview of Advanced Alchemy's security protocols",
"url": "https://github.com/litestar-org/.github?tab=coc-ov-file#security-ov-file",
"icon": "coc",
},
{"title": "Sponsor", "url": "https://github.com/sponsors/Litestar-Org", "icon": "heart"},
],
},
{
"title": "Help",
"children": [
{
"title": "Discord Help Forum",
"summary": "Dedicated Discord help forum",
"url": "https://discord.gg/dSDXd4mKhp",
"icon": "coc",
},
{
"title": "GitHub Discussions",
"summary": "GitHub Discussions",
"url": "https://github.com/litestar-org/advanced-alchemy/discussions",
"icon": "coc",
},
],
},
],
}
def update_html_context(
_app: Sphinx,
_pagename: str,
_templatename: str,
context: dict[str, Any],
_doctree: document,
) -> None:
context["generate_toctree_html"] = partial(context["generate_toctree_html"], startdepth=0)
def setup(app: Sphinx) -> dict[str, bool]:
app.setup_extension("shibuya")
return {"parallel_read_safe": True, "parallel_write_safe": True}
|
