Skip to content

Commit

Permalink
docs: add missing api docs for plugins (#3169)
Browse files Browse the repository at this point in the history
Co-authored-by: Janek Nouvertné <[email protected]>
  • Loading branch information
JacobCoffee and provinzkraut authored Mar 16, 2024
1 parent 1a23029 commit d6dd4d8
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ API reference
openapi/index
pagination
params
plugins
plugins/index
repository/index
response/index
router
Expand Down
6 changes: 0 additions & 6 deletions docs/reference/plugins.rst

This file was deleted.

13 changes: 13 additions & 0 deletions docs/reference/plugins/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
=======
plugins
=======

.. automodule:: litestar.plugins
:members:

.. toctree::
:maxdepth: 1
:hidden:

structlog
sqlalchemy
6 changes: 6 additions & 0 deletions docs/reference/plugins/sqlalchemy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
==========
sqlalchemy
==========

.. automodule:: litestar.plugins.sqlalchemy
:members:
6 changes: 6 additions & 0 deletions docs/reference/plugins/structlog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
=========
structlog
=========

.. automodule:: litestar.plugins.structlog
:members:

0 comments on commit d6dd4d8

Please sign in to comment.