From ec9dc1e2a013d7e81fafec0b05c0f1c589e9f73e Mon Sep 17 00:00:00 2001
From: Alan Crosswell <alan@crosswell.us>
Date: Tue, 30 Jul 2024 12:14:48 -0400
Subject: [PATCH] Correct the documentation of how to import extension snippets

The method documented here (adding to PROJECT/schema.py and PROJECT/__init__.py) is too early, before the app is ready. Instead copied the instructions at https://drf-spectacular.readthedocs.io/en/latest/customization.html#step-5-extensions which loads the extensions in the ready() method
---
 docs/blueprints.rst | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/docs/blueprints.rst b/docs/blueprints.rst
index ab910217..32185a82 100644
--- a/docs/blueprints.rst
+++ b/docs/blueprints.rst
@@ -14,10 +14,20 @@ Blueprint files can be found `here <https://github.com/tfranzel/drf-spectacular/
 
 .. note:: Simply copy&paste the snippets into your codebase. The extensions register
   themselves automatically. Just be sure that the python interpreter sees them at least once.
-  To that end, we suggest creating a ``PROJECT/schema.py`` file and importing it in your
-  ``PROJECT/__init__.py`` (same directory as ``settings.py`` and ``urls.py``)
-  with ``import PROJECT.schema``. Now you are all set.
+  It is good practice to collect your extensions in ``YOUR_MAIN_APP_NAME/schema.py`` and importing that
+  file in your ``YOUR_MAIN_APP_NAME/apps.py``. Every proper Django app will already have an auto-generated
+  ``apps.py`` file. Although not strictly necessary, doing the import in ``ready()`` is the most robust
+  approach. It will make sure your environment (e.g. settings) is properly set up prior to loading.
 
+.. code-block:: python
+
+    # your_main_app_name/apps.py
+    class YourMainAppNameConfig(AppConfig):
+        default_auto_field = "django.db.models.BigAutoField"
+        name = "your_main_app_name"
+
+        def ready(self):
+            import your_main_app_name.schema  # noqa: E402
 
 dj-stripe
 ---------