Deploying to gh-pages from @ litestar-org/litestar@da30d9f 🚀

litestar-org · Jan 5, 2025 · 0074ad6 · 0074ad6
1 parent 47999d4
commit 0074ad6
Show file tree

Hide file tree

Showing 287 changed files with 32,371 additions and 14,263 deletions.
diff --git a/3351/.buildinfo b/3351/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 5f4cb5c7390bd963f287c615ed7bbdab
+config: c4c876f80fdbc557678f6722246a88fc
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/3351/_sources/admonitions/sync-to-thread-info.rst.txt b/3351/_sources/admonitions/sync-to-thread-info.rst.txt
@@ -7,8 +7,11 @@
     running the event loop, and in turn block the whole application.
 
     To mitigate this, the ``sync_to_thread`` parameter can be set to ``True``, which
-    will result in the function being run in a thread pool. Should the function be
-    non-blocking, ``sync_to_thread`` should be set to ``False`` instead.
+    will result in the function being run in a thread pool.
+
+    If a synchronous function is non-blocking, setting ``sync_to_thread`` to ``False``
+    will tell Litestar that the user is sure about its behavior
+    and the function can be treated as non-blocking.
 
     If a synchronous function is passed, without setting an explicit ``sync_to_thread``
     value, a warning will be raised.

diff --git a/3351/_sources/index.rst.txt b/3351/_sources/index.rst.txt
@@ -155,12 +155,6 @@ A huge thank you to our current sponsors:
         </a>
         <p style="text-align: center;">Telemetry Sports</p>
       </div>
-      <div>
-        <a href="https://www.stok.kr/" title="Stok - Stack Up Your Assets!">
-            <img src="https://avatars.githubusercontent.com/u/144093421?s=400&v=4" alt="Stok" style="border-radius: 10px; width: auto; max-height: 150px;" />
-        </a>
-        <p style="text-align: center;">Stok</p>
-      </div>
     </div>
 
 We invite organizations and individuals to join our sponsorship program.
@@ -325,13 +319,13 @@ Example Applications
 --------------------
 
 
-* `litestar-pg-redis-docker <https://github.com/litestar-org/litestar-pg-redis-docker>`_ : In addition to Litestar, this
-  demonstrates a pattern of application modularity, SQLAlchemy 2.0 ORM, Redis cache connectivity, and more. Like all
-  Litestar projects, this application is open to contributions, big and small.
 * `litestar-fullstack <https://github.com/litestar-org/litestar-fullstack>`_ : A fully-capable, production-ready fullstack
   Litestar web application configured with best practices. It includes SQLAlchemy 2.0, VueJS, `Vite <https://vitejs.dev/>`_,
   `SAQ job queue <https://saq-py.readthedocs.io/en/latest/>`_, ``Jinja`` templates and more.
-  `Read more <https://litestar-org.github.io/litestar-fullstack/latest/>`_.
+  `Read more <https://litestar-org.github.io/litestar-fullstack/latest/>`_. Like all
+  Litestar projects, this application is open to contributions, big and small.
+* `litestar-fullstack-inertia <https://github.com/litestar-org/litestar-fullstack-inertia>`_ : Similar to
+  `Litestar Fullstack <https://litestar-org.github.io/litestar-fullstack/latest/>`_ but uses `Inertia.js <https://inertiajs.com>`_.
 * `litestar-hello-world <https://github.com/litestar-org/litestar-hello-world>`_: A bare-minimum application setup.
   Great for testing and POC work.
 
@@ -360,5 +354,5 @@ Example Applications
     :hidden:
 
     contribution-guide
-    Available Issues <https://github.com/search?q=user%3Alitestar-org+state%3Aopen+label%3A%22good+first+issue%22+++no%3Aassignee+&type=issues=>
+    Available Issues <https://github.com/search?q=user%3Alitestar-org+state%3Aopen+label%3A%22good+first+issue%22+++no%3Aassignee+&type=issues>
     Code of Conduct <https://github.com/litestar-org/.github?tab=coc-ov-file#readme>
diff --git a/3351/_sources/migration/flask.rst.txt b/3351/_sources/migration/flask.rst.txt
@@ -202,11 +202,11 @@ Request methods
 +---------------------------------+-------------------------------------------------------------------------------------------------------+
 | ``request.environ``             | ``request.scope``                                                                                     |
 +---------------------------------+-------------------------------------------------------------------------------------------------------+
-| ``request.files``               | Use ```UploadFile`` <usage/4-request-data/#file-uploads>`__                                           |
+| ``request.files``               | Use ```UploadFile`` <usage/requests/file-uploads>`__                                                  |
 +---------------------------------+-------------------------------------------------------------------------------------------------------+
-| ``request.form``                | ``request.form()``, prefer ```Body`` <usage/4-request-data/#specifying-a-content-type>`__             |
+| ``request.form``                | ``request.form()``, prefer ```Body`` <usage/requests/content-type>`__                                 |
 +---------------------------------+-------------------------------------------------------------------------------------------------------+
-| ``request.get_json``            | ``request.json()``, prefer the ```data keyword argument`` <usage/4-request-data/#request-body>`__     |
+| ``request.get_json``            | ``request.json()``, prefer the ```data keyword argument`` <usage/requests/request-body>`__            |
 +---------------------------------+-------------------------------------------------------------------------------------------------------+
 | ``request.headers``             | ``request.headers``                                                                                   |
 +---------------------------------+-------------------------------------------------------------------------------------------------------+

diff --git a/3351/_sources/reference/concurrency.rst.txt b/3351/_sources/reference/concurrency.rst.txt
@@ -1,5 +1,5 @@
-cli
-===
+concurrency
+===========
 
 .. automodule:: litestar.concurrency
     :members:
diff --git a/3351/_sources/reference/exceptions.rst.txt b/3351/_sources/reference/exceptions.rst.txt
@@ -3,3 +3,6 @@ exceptions
 
 .. automodule:: litestar.exceptions
     :members:
+
+.. automodule:: litestar.exceptions.responses
+    :members:
diff --git a/3351/_sources/reference/plugins/attrs.rst.txt b/3351/_sources/reference/plugins/attrs.rst.txt
@@ -0,0 +1,5 @@
+attrs
+=====
+
+.. automodule:: litestar.plugins.attrs
+    :members:
diff --git a/3351/_sources/reference/plugins/htmx.rst.txt b/3351/_sources/reference/plugins/htmx.rst.txt
@@ -0,0 +1,7 @@
+====
+htmx
+====
+
+
+.. automodule:: litestar.plugins.htmx
+    :members:
diff --git a/3351/_sources/reference/plugins/index.rst.txt b/3351/_sources/reference/plugins/index.rst.txt
@@ -9,6 +9,11 @@ plugins
     :maxdepth: 1
     :hidden:
 
+    attrs
     flash_messages
+    htmx
+    problem_details
+    prometheus
+    pydantic
     structlog
     sqlalchemy
diff --git a/3351/_sources/reference/plugins/problem_details.rst.txt b/3351/_sources/reference/plugins/problem_details.rst.txt
@@ -0,0 +1,7 @@
+===============
+problem details
+===============
+
+
+.. automodule:: litestar.plugins.problem_details
+    :members:
diff --git a/3351/_sources/reference/plugins/prometheus.rst.txt b/3351/_sources/reference/plugins/prometheus.rst.txt
@@ -0,0 +1,5 @@
+prometheus
+==========
+
+.. automodule:: litestar.plugins.prometheus
+    :members:
diff --git a/3351/_sources/reference/plugins/pydantic.rst.txt b/3351/_sources/reference/plugins/pydantic.rst.txt
@@ -0,0 +1,5 @@
+pydantic
+========
+
+.. automodule:: litestar.plugins.pydantic
+    :members:
diff --git a/3351/_sources/reference/stores/index.rst.txt b/3351/_sources/reference/stores/index.rst.txt
@@ -8,3 +8,4 @@ stores
     memory
     redis
     registry
+    valkey
diff --git a/3351/_sources/reference/stores/valkey.rst.txt b/3351/_sources/reference/stores/valkey.rst.txt
@@ -0,0 +1,5 @@
+valkey
+======
+
+.. automodule:: litestar.stores.valkey
+    :members:
diff --git a/3351/_sources/reference/testing.rst.txt b/3351/_sources/reference/testing.rst.txt
@@ -3,7 +3,7 @@ testing
 
 
 .. automodule:: litestar.testing
-    :members: RequestFactory, BaseTestClient, TestClient, AsyncTestClient, create_async_test_client, create_test_client
+    :members: RequestFactory, BaseTestClient, TestClient, AsyncTestClient, create_async_test_client, create_test_client, subprocess_sync_client, subprocess_async_client
     :undoc-members: WebSocketTestSession
 
 

diff --git a/3351/_sources/reference/types.rst.txt b/3351/_sources/reference/types.rst.txt
@@ -1,7 +1,7 @@
 types
 =====
 
-.. py:currentmodule:: litestar.types
+.. module:: litestar.types
 
 
 
@@ -58,15 +58,15 @@ ASGI Application Parameters
 ASGI Scopes
 ~~~~~~~~~~~~
 
-.. autodata:: litestar.types.ASGIVersion
+.. autoclass:: litestar.types.ASGIVersion
 
-.. autodata:: litestar.types.BaseScope
+.. autoclass:: litestar.types.BaseScope
 
-.. autodata:: litestar.types.HTTPScope
+.. autoclass:: litestar.types.HTTPScope
 
-.. autodata:: litestar.types.LifeSpanScope
+.. autoclass:: litestar.types.LifeSpanScope
 
-.. autodata:: litestar.types.WebSocketScope
+.. autoclass:: litestar.types.WebSocketScope
 
 
 ASGI Events
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,3 +8,4 @@ stores @@
         memory
         redis
         registry
+        valkey