Added badge and other comments to documentation. Addresses issues #59 and #61

Mark Gibbs · Mark Gibbs · commit bb3208acb24c · 2018-11-03T20:44:47.000-07:00
diff --git a/dev_requirements.txt b/dev_requirements.txt
@@ -12,6 +12,7 @@ pytest-django
 pytest-cov
 pytz
 redis
+sphinx
 sphinx-autobuild
 twine
 
diff --git a/dev_requirements.yaml b/dev_requirements.yaml
@@ -20,4 +20,5 @@ dependencies:
     - django-redis
     - grip
     - pytest-django
+    - sphinx
     - sphinx-autobuild
diff --git a/docs/dash_components.rst b/docs/dash_components.rst
@@ -8,7 +8,7 @@ dependency of ``django-plotly-dash``.
 
 .. _pipe_component:
 The ``Pipe`` component
---------------
+----------------------
 
 Each ``Pipe`` component instance listens for messages on a single channel. The ``value`` member of any message on that channel whose ``label`` matches
 that of the component will be used to update the ``value`` property of the component. This property can then be used in callbacks like
diff --git a/docs/development.rst b/docs/development.rst
@@ -7,6 +7,13 @@ The application and demo are developed, built and tested in a virtualenv envirom
 a number of ``bash`` shell scripts. The resultant package should work on any Python installation
 that meets the requirements.
 
+Automatic builds have been set up on `Travis-CI <https://travis-ci.org/GibbsConsulting/django-plotly-dash>`_ including
+running tests and reporting code coverage.
+
+Current status: |Travis Badge|
+
+.. |Travis Badge| image:: https://travis-ci.org/GibbsConsulting/django-plotly-dash.svg?branch=master
+
 Environment setup
 -----------------
 
diff --git a/docs/extended_callbacks.rst b/docs/extended_callbacks.rst
@@ -52,7 +52,7 @@ in the :ref:`models_and_state` section.
 
 .. _using_session_state:
 Using session state
-------------------
+-------------------
 
 Unless an explicit pipe is created, 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 callback; at this point the
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -20,3 +20,10 @@ own requirements but are accessed using standard network protocols.
 
 Create a `github issue <https://github.com/GibbsConsulting/django-plotly-dash/issues>`_. See :ref:`bug reporting <bug-reporting>` for details
 on what makes a good bug report.
+
+* Where should ``Dash`` layout and callback functions be placed?
+
+In general, the only constraint on the files containing these functions is that they should be imported into the file containing
+the ``DjangoDash`` instantiation. This is discussed in
+the :ref:`installation` section and also
+in this github `issue <https://github.com/GibbsConsulting/django-plotly-dash/issues/58>`_.
diff --git a/docs/license.rst b/docs/license.rst
@@ -1,4 +1,4 @@
-.. _license
+.. _license:
 
 License
 =======
diff --git a/docs/models_and_state.rst b/docs/models_and_state.rst
@@ -6,7 +6,7 @@ Django models and application state
 The ``django_plotly_dash`` application defines ``DashApp`` and ``StatelessApp`` models.
 
 The ``StatelessApp`` model
-----------------------
+--------------------------
 
 An instance of the ``StatelessApp`` model represents a single dash application. Every instantiation of
 a ``DjangoDash`` object is registered, and any object that is referenced through the ``DashApp`` model - this
diff --git a/docs/template_tags.rst b/docs/template_tags.rst
@@ -123,7 +123,7 @@ the page footer - to avoid delaying the main page load - along
 with other scripts is generally advisable.
 
 The ``plotly_app_identifier`` template tag
------------------------------------------
+------------------------------------------
 
 This tag provides an identifier for an app, in a form that is suitable for use as a classname or identifier
 in HTML:

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-.. _license`
	`1`	`+.. _license:`
`2`	`2`
`3`	`3`	`License`
`4`	`4`	`=======`