Skip to content

Commit 70d3a95

Browse files
author
Mark Gibbs
committed
Minor documentation tweaks
1 parent 44fa5f0 commit 70d3a95

File tree

3 files changed

+22
-5
lines changed

3 files changed

+22
-5
lines changed

docs/extended_callbacks.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,8 @@ in the :ref:`models_and_state` section.
5454
Using session state
5555
------------------
5656

57-
Changes to the session state and other server-side objects are not automatically propagated to an application. Something in the front-end UI has to invoke a callaback; at this point the latest version of these objects will be provided to the callback. The same considerations as in other Dash `live updates <https://dash.plot.ly/live-updates>`_ apply.
57+
Changes to the session state and other server-side objects are not automatically
58+
propagated to an application. Something in the front-end UI has to invoke a callback; at this point the
59+
latest version of these objects will be provided to the callback. The same considerations
60+
as in other Dash `live updates <https://dash.plot.ly/live-updates>`_ apply.
5861

docs/installation.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,32 @@ Use pip to install the package, preferably to a local virtualenv.::
77

88
pip install django_plotly_dash
99

10-
Then, add ``django_plotly_dash`` to ``INSTALLED_APPS`` in the Django settings.py file::
10+
Then, add ``django_plotly_dash`` to ``INSTALLED_APPS`` in the Django ``settings.py`` file::
1111

1212
INSTALLED_APPS = [
1313
...
1414
'django_plotly_dash.apps.DjangoPlotlyDashConfig',
1515
...
1616
]
1717

18-
The ``plotly_item`` tag in the ``plotly_dash`` tag library can then be used to render any registered dash component. See :ref:`simple_use` for a simple example.
19-
2018
The project directory name ``django_plotly_dash`` can also be used on its own if preferred, but this will then skip the use of readable application names in
2119
the Django admin interface.
2220

21+
The application's routes need to be registered within the routing structure by an appropriate ``include`` statement in
22+
a ``urls.py`` file::
23+
24+
urlpatterns = [
25+
...
26+
path('django_plotly_dash/', include('django_plotly_dash.urls')),
27+
]
28+
29+
Finally, a migration is needed to update the
30+
database::
31+
32+
./manage.py migrate
33+
34+
The ``plotly_item`` tag in the ``plotly_dash`` tag library can then be used to render any registered dash component. See :ref:`simple_use` for a simple example.
35+
2336
Source code and demo
2437
--------------------
2538

@@ -40,3 +53,4 @@ To install and run it::
4053
# at http://localhost:8000
4154

4255
This will launch a simple Django application. A superuser account is also configured, with both username and password set to ``admin``.
56+

docs/models_and_state.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ be created if one does not already exist.
3131
'''
3232
3333
The main role of a ``StatelessApp`` instance is to manage access to the associated ``DjangoDash`` object, as
34-
expsosed through the ``as_dash_app`` member
34+
exposed through the ``as_dash_app`` member
3535
function.
3636

3737
The ``DashApp`` model

0 commit comments

Comments
 (0)