Update docs, fixes #357

coleifer · Aug 18, 2022 · 0190344 · 0190344
1 parent 2bfe759
commit 0190344
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/django.rst b/docs/django.rst
@@ -267,6 +267,19 @@ your settings.
         'immediate': False,
     }
 
+Getting the Huey Instance
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you want to interact with Huey APIs that are not exposed through ``djhuey``
+explicitly, you can get the actual ``Huey`` instance in the following way:
+
+.. code-block:: python
+
+    from huey.contrib.djhuey import HUEY as huey
+
+    # E.g., get the underlying Storage instance.
+    storage = huey.get_storage()
+
 Configuration Examples
 ^^^^^^^^^^^^^^^^^^^^^^