Skip to content

Commit 4becd50

Browse files
authored
chore: cleanup docs (#572)
Various updates to agent guides and documentation
1 parent a36236b commit 4becd50

6 files changed

Lines changed: 25 additions & 188 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AGENTS.md
22

3-
This file provides guidance to Gemini, Claude Code, Codex, and other agents when working with code in the Advanced Alchemy project..
3+
This file provides guidance to Gemini, Claude Code, Codex, and other agents when working with code in the Advanced Alchemy project.
44

55
## Essential Commands
66

docs/Makefile

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/_static/theme.js

Lines changed: 0 additions & 49 deletions
This file was deleted.

docs/_static/versioning.js

Lines changed: 0 additions & 104 deletions
This file was deleted.

docs/conf.py

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,25 @@
3030
"autosectionlabel.*",
3131
"ref.python", # TODO: remove when https://github.com/sphinx-doc/sphinx/issues/4961 is fixed
3232
]
33+
3334
# -- General configuration ---------------------------------------------------
3435
extensions = [
35-
"sphinx.ext.intersphinx",
36+
# Sphinx core extensions
3637
"sphinx.ext.autodoc",
37-
"sphinx.ext.napoleon",
3838
"sphinx.ext.autosectionlabel",
3939
"sphinx.ext.githubpages",
40+
"sphinx.ext.intersphinx",
41+
"sphinx.ext.napoleon",
42+
"sphinx.ext.todo",
4043
"sphinx.ext.viewcode",
44+
# Custom extensions
4145
"tools.sphinx_ext.missing_references",
4246
"tools.sphinx_ext.changelog",
47+
# Third-party extensions
4348
"sphinx_autodoc_typehints",
4449
"myst_parser",
4550
"auto_pytabs.sphinx_ext",
4651
"sphinx_copybutton",
47-
"sphinx.ext.todo",
48-
"sphinx.ext.viewcode",
4952
"sphinx_click",
5053
"sphinx_toolbox.collapse",
5154
"sphinx_design",
@@ -67,14 +70,9 @@
6770
"sanic": ("https://sanic.readthedocs.io/en/latest/", None),
6871
"flask": ("https://flask.palletsprojects.com/en/stable/", None),
6972
"typing_extensions": ("https://typing-extensions.readthedocs.io/en/stable/", None),
73+
"attrs": ("https://www.attrs.org/en/stable/", None),
74+
"pytest": ("https://docs.pytest.org/en/stable/", None),
7075
}
71-
PY_CLASS = "py:class"
72-
PY_EXC = "py:exc"
73-
PY_RE = r"py:.*"
74-
PY_METH = "py:meth"
75-
PY_ATTR = "py:attr"
76-
PY_OBJ = "py:obj"
77-
PY_FUNC = "py:func"
7876
nitpicky = True
7977
nitpick_ignore: list[str] = []
8078
nitpick_ignore_regex: list[str] = []
@@ -94,6 +92,8 @@
9492
autodoc_default_options = {"special-members": "__init__", "show-inheritance": True, "members": True}
9593
autodoc_member_order = "bysource"
9694
autodoc_typehints_format = "short"
95+
autodoc_typehints = "both"
96+
autodoc_preserve_defaults = True
9797
autodoc_type_aliases = {
9898
"ModelT": "advanced_alchemy.repository.typing.ModelT",
9999
"FilterTypeT": "advanced_alchemy.filters.FilterTypeT",
@@ -170,7 +170,6 @@
170170
"_sa.create_engine._sphinx_paramlinks_creator",
171171
"sqlalchemy.Dialect",
172172
"sqlalchemy.orm.MetaData",
173-
# Add these new entries:
174173
"advanced_alchemy.config.engine.EngineConfig",
175174
"advanced_alchemy.config.asyncio.AsyncSessionConfig",
176175
"advanced_alchemy.config.sync.SyncSessionConfig",
@@ -209,12 +208,23 @@
209208
html_static_path = ["_static"]
210209
html_favicon = "_static/favicon.png"
211210
templates_path = ["_templates"]
212-
html_js_files = ["versioning.js"]
213211
html_css_files = ["custom.css", "syntax-highlighting.css"]
214212
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "PYPI_README.md", "guides/**"]
215213
html_show_sourcelink = True
216214
html_copy_source = True
217215

216+
# Add SEO-friendly meta tags
217+
html_meta = {
218+
"description": "Advanced Alchemy - A carefully crafted, thoroughly tested, optimized companion library for SQLAlchemy",
219+
"keywords": "sqlalchemy, orm, alembic, python, database, litestar, repository-pattern, fastapi, starlette",
220+
"author": "Litestar Organization",
221+
"og:title": "Advanced Alchemy Documentation",
222+
"og:type": "website",
223+
"og:description": "Advanced Alchemy - A carefully crafted, thoroughly tested, optimized companion library for SQLAlchemy",
224+
"og:site_name": "Advanced Alchemy",
225+
"twitter:card": "summary",
226+
}
227+
218228
html_context = {
219229
"source_type": "github",
220230
"source_user": "litestar-org",

docs/guides/patterns/repository-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Repository-Service Pattern
22

3-
Advanced Alchemy repository-service pattern reference. See [AGENTS.md](/home/cody/code/litestar/advanced-alchemy/AGENTS.md) for complete conventions.
3+
Advanced Alchemy repository-service pattern reference. See [AGENTS.md](../../../AGENTS.md) for complete conventions.
44

55
## Core Pattern
66

0 commit comments

Comments
 (0)