Skip to content

Commit 7c1ec69

Browse files
committed
Update documentation to recommend installing wagtail_modeladmin when using Wagtail 5.1+
1 parent fe74326 commit 7c1ec69

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/source/index.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,27 @@ Installation
3030
Use your favorite Python installer to install it from PyPI::
3131

3232
pip install wagtail-robots
33+
pip install wagtail_modeladmin # if Wagtail >= 5.1
3334

3435
Or get the source from the application site at::
3536

3637
http://github.com/adrian-turjak/wagtail-robots/
3738

3839
Then follow these steps:
3940

40-
1. Add ``'wagtail_modeladmin'`` (if the Wagtail version is 5.1 and above, otherwise ``'wagtail.contrib.modeladmin'``) and ``'robots'`` to your INSTALLED_APPS_ setting.
41+
1. Add ``robots`` and ``modeladmin`` to the
42+
``INSTALLED_APPS`` setting in your project settings:
43+
44+
.. code-block:: python
45+
:caption: e.g. settings.py
46+
47+
INSTALLED_APPS = [
48+
...
49+
'wagtail_modeladmin', # if Wagtail >=5.1; Don't repeat if it's there already
50+
'wagtail.contrib.modeladmin', # if Wagtail <5.1; Don't repeat if it's there already
51+
'robots',
52+
]
53+
4154
2. Run the ``migrate`` management command
4255

4356
You may want to additionally setup the `Wagtail sitemap generator`_.

0 commit comments

Comments
 (0)