From bf96a8fe50c88aa86cd326dfcc299d0882412939 Mon Sep 17 00:00:00 2001 From: Peter Bittner Date: Thu, 19 May 2016 00:14:08 +0200 Subject: [PATCH] Fix some white space and highlighting in docs --- docs/install.rst | 61 +++++++++++++++++++++++++++--------------------- 1 file changed, 35 insertions(+), 26 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 37db7a0..14fe1d1 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -20,23 +20,29 @@ Installing the Python package To install django-analytical the ``analytical`` package must be added to the Python path. You can install it directly from PyPI using -``easy_install``:: +``easy_install``: - $ easy_install django-analytical +.. code-block:: bash + + $ easy_install django-analytical You can also install directly from source. Download either the latest stable version from PyPI_ or any release from GitHub_, or use Git to -get the development code:: +get the development code: - $ git clone https://github.com/jcassee/django-analytical.git +.. code-block:: bash + + $ git clone https://github.com/jcassee/django-analytical.git .. _PyPI: http://pypi.python.org/pypi/django-analytical/ .. _GitHub: http://github.com/jcassee/django-analytical -Then install the package by running the setup script:: +Then install the package by running the setup script: - $ cd django-analytical - $ python setup.py install +.. code-block:: + + $ cd django-analytical + $ python setup.py install .. _installing-the-application: @@ -46,13 +52,15 @@ Installing the Django application After you installed django-analytical, add the ``analytical`` Django application to the list of installed applications in the ``settings.py`` -file of your project:: +file of your project: - INSTALLED_APPS = [ - ... - 'analytical', - ... - ] +.. code-block:: python + + INSTALLED_APPS = [ + ... + 'analytical', + ... + ] .. _adding-the-template-tags: @@ -64,7 +72,9 @@ Because every analytics service uses own specific Javascript code that should be added to the top or bottom of either the head or body of the HTML page, django-analytical provides four general-purpose template tags that will render the code needed for the services you are using. Your -base template should look like this:: +base template should look like this: + +.. code-block:: html {% load analytical %} @@ -101,27 +111,27 @@ settings required to enable each service are listed here: * :doc:`Chartbeat `:: - CHARTBEAT_USER_ID = '12345' + CHARTBEAT_USER_ID = '12345' * :doc:`Clickmap `:: - CLICKMAP_TRACKER_CODE = '12345678....912' + CLICKMAP_TRACKER_CODE = '12345678....912' * :doc:`Clicky `:: - CLICKY_SITE_ID = '12345678' + CLICKY_SITE_ID = '12345678' * :doc:`Crazy Egg `:: - CRAZY_EGG_ACCOUNT_NUMBER = '12345678' + CRAZY_EGG_ACCOUNT_NUMBER = '12345678' * :doc:`Gaug.es `:: - GAUGES_SITE_ID = '0123456789abcdef0123456789abcdef' + GAUGES_SITE_ID = '0123456789abcdef0123456789abcdef' * :doc:`Google Analytics `:: - GOOGLE_ANALYTICS_PROPERTY_ID = 'UA-1234567-8' + GOOGLE_ANALYTICS_PROPERTY_ID = 'UA-1234567-8' * :doc:`HubSpot `:: @@ -134,16 +144,16 @@ settings required to enable each service are listed here: * :doc:`KISSinsights `:: - KISS_INSIGHTS_ACCOUNT_NUMBER = '12345' - KISS_INSIGHTS_SITE_CODE = 'abc' + KISS_INSIGHTS_ACCOUNT_NUMBER = '12345' + KISS_INSIGHTS_SITE_CODE = 'abc' * :doc:`KISSmetrics `:: - KISS_METRICS_API_KEY = '0123456789abcdef0123456789abcdef01234567' + KISS_METRICS_API_KEY = '0123456789abcdef0123456789abcdef01234567' * :doc:`Mixpanel `:: - MIXPANEL_API_TOKEN = '0123456789abcdef0123456789abcdef' + MIXPANEL_API_TOKEN = '0123456789abcdef0123456789abcdef' * :doc:`Olark `:: @@ -151,7 +161,7 @@ settings required to enable each service are listed here: * :doc:`Optimizely `:: - OPTIMIZELY_ACCOUNT_NUMBER = '1234567' + OPTIMIZELY_ACCOUNT_NUMBER = '1234567' * :doc:`Performable `:: @@ -166,7 +176,6 @@ settings required to enable each service are listed here: WOOPRA_DOMAIN = 'abcde.com' - ---- The django-analytical application is now set-up to track visitors. For