diff --git a/docs/conf.py b/docs/conf.py index 4bf2055296..b1ff093e6c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -115,6 +115,7 @@ (PY_CLASS, "NoneType"), (PY_CLASS, "litestar._openapi.schema_generation.schema.SchemaCreator"), (PY_CLASS, "litestar._signature.model.SignatureModel"), + (PY_CLASS, "litestar.contrib.sqlalchemy.plugins.init.config.compat._CreateEngineMixin"), (PY_CLASS, "litestar.utils.signature.ParsedSignature"), (PY_CLASS, "litestar.utils.sync.AsyncCallable"), # types in changelog that no longer exist diff --git a/docs/usage/databases/sqlalchemy/plugins/sqlalchemy_init_plugin.rst b/docs/usage/databases/sqlalchemy/plugins/sqlalchemy_init_plugin.rst index 158a147265..2ebd069f6a 100644 --- a/docs/usage/databases/sqlalchemy/plugins/sqlalchemy_init_plugin.rst +++ b/docs/usage/databases/sqlalchemy/plugins/sqlalchemy_init_plugin.rst @@ -39,7 +39,8 @@ Renaming the dependencies ######################### You can change the name that the engine and session are bound to by setting the -:attr:`engine_dependency_key` and :attr:`session_dependency_key` +:attr:`engine_dependency_key ` +and :attr:`session_dependency_key ` attributes on the plugin configuration. Configuring the before send handler @@ -49,9 +50,9 @@ The plugin configures a ``before_send`` handler that is called before sending a session and removes it from the connection scope. You can change the handler by setting the -:attr:`before_send_handler` attribute -on the configuration object. For example, an alternate handler is available that will also commit the session on success -and rollback upon failure. +:attr:`before_send_handler ` +attribute on the configuration object. For example, an alternate handler is available that will also commit the session +on success and rollback upon failure. .. tab-set::