From d6dd4d8547151baad7eb1b071451d26df0da0f19 Mon Sep 17 00:00:00 2001 From: Jacob Coffee Date: Sat, 16 Mar 2024 15:08:20 -0500 Subject: [PATCH] docs: add missing api docs for plugins (#3169) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Janek Nouvertné --- docs/reference/index.rst | 2 +- docs/reference/plugins.rst | 6 ------ docs/reference/plugins/index.rst | 13 +++++++++++++ docs/reference/plugins/sqlalchemy.rst | 6 ++++++ docs/reference/plugins/structlog.rst | 6 ++++++ 5 files changed, 26 insertions(+), 7 deletions(-) delete mode 100644 docs/reference/plugins.rst create mode 100644 docs/reference/plugins/index.rst create mode 100644 docs/reference/plugins/sqlalchemy.rst create mode 100644 docs/reference/plugins/structlog.rst diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 6fcd7bc88e..1929bf6b5d 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -28,7 +28,7 @@ API reference openapi/index pagination params - plugins + plugins/index repository/index response/index router diff --git a/docs/reference/plugins.rst b/docs/reference/plugins.rst deleted file mode 100644 index 626910d988..0000000000 --- a/docs/reference/plugins.rst +++ /dev/null @@ -1,6 +0,0 @@ -plugins -======= - - -.. automodule:: litestar.plugins - :members: diff --git a/docs/reference/plugins/index.rst b/docs/reference/plugins/index.rst new file mode 100644 index 0000000000..5de973df3c --- /dev/null +++ b/docs/reference/plugins/index.rst @@ -0,0 +1,13 @@ +======= +plugins +======= + +.. automodule:: litestar.plugins + :members: + +.. toctree:: + :maxdepth: 1 + :hidden: + + structlog + sqlalchemy diff --git a/docs/reference/plugins/sqlalchemy.rst b/docs/reference/plugins/sqlalchemy.rst new file mode 100644 index 0000000000..ae20c64bf5 --- /dev/null +++ b/docs/reference/plugins/sqlalchemy.rst @@ -0,0 +1,6 @@ +========== +sqlalchemy +========== + +.. automodule:: litestar.plugins.sqlalchemy + :members: diff --git a/docs/reference/plugins/structlog.rst b/docs/reference/plugins/structlog.rst new file mode 100644 index 0000000000..85516bf4a8 --- /dev/null +++ b/docs/reference/plugins/structlog.rst @@ -0,0 +1,6 @@ +========= +structlog +========= + +.. automodule:: litestar.plugins.structlog + :members: