Skip to content

Commit

Permalink
Merge pull request #80 from drf-forms/improve-install-documentation
Browse files Browse the repository at this point in the history
📖 actually mention adding drf_auto_endpoint to INSTALLED_APPS
  • Loading branch information
nanuxbe committed Feb 27, 2023
2 parents dcc8d5d + b5987db commit cc396f0
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion docs/cookbooks/basics/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,19 @@ Thanks to `drf_auto_endpoint`, **DRF-schema-adapter** helps you register endpoin
easily as registering basic admin classes.

In order to register endpoints, you'll have to import `drf_auto_endpoint`'s router as
well as the models you want to register inside your `urls.py`.
well as the models you want to register inside your `urls.py`. For admin-style
registration (auto-discovery) to work, you will also have to add `def_auto_endpoint`
to your `INSTALLED_APPS`

```python
#settings.py

INSTALLED_APPS = [
...

`drf_auto_endpoint`,
]
```

```
## urls.py
Expand All @@ -40,6 +52,9 @@ If you don't want to import your models directly in your `urls.py`, you can also
advantage of `drf_auto_endpoint`'s auto-discovery capabilities and add your registrations
to an `endpoints.py` file in your app.

:warning: For auto-discovery to work, you will need to have `def_auto_endpoint` in your
`INSTALLED_APPS`

```
## urls.py
Expand Down

0 comments on commit cc396f0

Please sign in to comment.