From 01903447f5665ba063afaa9f3abab51d35950b4f Mon Sep 17 00:00:00 2001 From: Charles Leifer Date: Thu, 18 Aug 2022 08:04:55 -0500 Subject: [PATCH] Update docs, fixes #357 --- docs/django.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/django.rst b/docs/django.rst index 5f3f713a..8e94b1f7 100644 --- 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 ^^^^^^^^^^^^^^^^^^^^^^