sphinx-contrib / googleanalytics /

Filename Size Date modified Message
49 B
1.2 KB
81 B
1.1 KB
.. -*- restructuredtext -*-

Google Analytics extension for Sphinx

:author: Domen Kožar <domen@dev.si>


This extensions allows you to track generated html files
with Google Analytics web service.

Installing from sphinx-contrib checkout

Checkout sphinx-contrib::

  $ hg clone https://bitbucket.org/birkenfeld/sphinx-contrib/

Change into the googleanalytics directory::

  $ cd sphinx-contrib/googleanalytics
Install the module::

  $ python setup.py install

Enabling the extension in Sphinx_

Just add ``sphinxcontrib.googleanalytics`` to the list of extensions in the ``conf.py``
file. For example::

    extensions = ['sphinxcontrib.googleanalytics']


For now one optional configuration is added to Sphinx_. It can be set in
``conf.py`` file:

``googleanalytics_id`` <string>:
	UA id for your site, example::
		googleanalytics_id = 'UA-123-123-123'

``googleanalytics_enabled`` <bool>:
	True by default, use it to turn off tracking.

.. Links:
.. _gnuplot: http://www.gnuplot.info/
.. _Sphinx: http://sphinx.pocoo.org/

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.