Skip to content

Commit 520294f

Browse files
committed
Added more debugging information to the docs.
1 parent 58dc393 commit 520294f

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

docs/debugging.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,17 @@ conjunction with third-party apps that attempt to do similar types of imports,
106106
it's possible (though rare) to get a traceback very early in the start-up
107107
process, usually mentioning ``handle_registrations``.
108108

109-
If this is the case, Haystack provides an advanced setting
109+
There are typically three possible causes for this error:
110+
111+
* A syntax/import error in a file included by the ``search_indexes.py`` file
112+
* A circular import
113+
* Another app causing models to load early
114+
115+
The first two causes can be debugged by dropping an
116+
``import pdb; pdb.set_trace()`` at the top of the ``search_indexes.py`` where
117+
the error is occurring and stepping through to see the real error.
118+
119+
If neither of those is the case, Haystack provides an advanced setting
110120
(``HAYSTACK_ENABLE_REGISTRATIONS`` - :doc:`settings`) to disable this importing
111121
behavior and allow your applications to function.
112122

0 commit comments

Comments
 (0)