Skip to content

Fix #1711 Improve installation page formats #1772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2023
Merged

Fix #1711 Improve installation page formats #1772

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ fully functional.
1. Install the Package
^^^^^^^^^^^^^^^^^^^^^^

The recommended way to install the Debug Toolbar is via pip_::
The recommended way to install the Debug Toolbar is via pip_:

.. code-block:: console

$ python -m pip install django-debug-toolbar

Expand All @@ -20,9 +22,11 @@ If you aren't familiar with pip, you may also obtain a copy of the
.. _pip: https://pip.pypa.io/

To test an upcoming release, you can install the in-development version
instead with the following command::
instead with the following command:

.. code-block:: console

$ python -m pip install -e git+https://github.com/jazzband/django-debug-toolbar.git#egg=django-debug-toolbar
$ python -m pip install -e git+https://github.com/jazzband/django-debug-toolbar.git#egg=django-debug-toolbar

If you're upgrading from a previous version, you should review the
:doc:`change log <changes>` and look for specific upgrade instructions.
Expand Down Expand Up @@ -64,7 +68,9 @@ Second, ensure that your ``TEMPLATES`` setting contains a
3. Install the App
^^^^^^^^^^^^^^^^^^

Add ``"debug_toolbar"`` to your ``INSTALLED_APPS`` setting::
Add ``"debug_toolbar"`` to your ``INSTALLED_APPS`` setting:

.. code-block:: python

INSTALLED_APPS = [
# ...
Expand All @@ -83,7 +89,7 @@ Add django-debug-toolbar's URLs to your project's URLconf:

urlpatterns = [
# ...
path('__debug__/', include('debug_toolbar.urls')),
path("__debug__/", include("debug_toolbar.urls")),
]

This example uses the ``__debug__`` prefix, but you can use any prefix that
Expand Down