Skip to content

Commit a3090b4

Browse files
authored
Fix #1711 Improve installation page formats (#1772)
1 parent 5429e5b commit a3090b4

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/installation.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ fully functional.
1010
1. Install the Package
1111
^^^^^^^^^^^^^^^^^^^^^^
1212

13-
The recommended way to install the Debug Toolbar is via pip_::
13+
The recommended way to install the Debug Toolbar is via pip_:
14+
15+
.. code-block:: console
1416
1517
$ python -m pip install django-debug-toolbar
1618
@@ -20,9 +22,11 @@ If you aren't familiar with pip, you may also obtain a copy of the
2022
.. _pip: https://pip.pypa.io/
2123

2224
To test an upcoming release, you can install the in-development version
23-
instead with the following command::
25+
instead with the following command:
26+
27+
.. code-block:: console
2428
25-
$ python -m pip install -e git+https://github.com/jazzband/django-debug-toolbar.git#egg=django-debug-toolbar
29+
$ python -m pip install -e git+https://github.com/jazzband/django-debug-toolbar.git#egg=django-debug-toolbar
2630
2731
If you're upgrading from a previous version, you should review the
2832
:doc:`change log <changes>` and look for specific upgrade instructions.
@@ -64,7 +68,9 @@ Second, ensure that your ``TEMPLATES`` setting contains a
6468
3. Install the App
6569
^^^^^^^^^^^^^^^^^^
6670

67-
Add ``"debug_toolbar"`` to your ``INSTALLED_APPS`` setting::
71+
Add ``"debug_toolbar"`` to your ``INSTALLED_APPS`` setting:
72+
73+
.. code-block:: python
6874
6975
INSTALLED_APPS = [
7076
# ...
@@ -83,7 +89,7 @@ Add django-debug-toolbar's URLs to your project's URLconf:
8389
8490
urlpatterns = [
8591
# ...
86-
path('__debug__/', include('debug_toolbar.urls')),
92+
path("__debug__/", include("debug_toolbar.urls")),
8793
]
8894
8995
This example uses the ``__debug__`` prefix, but you can use any prefix that

0 commit comments

Comments
 (0)