1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
.. -*- restructuredtext -*-
===========================================
Google Analytics extension for Sphinx
===========================================
:author: Domen Kožar <domen@dev.si>
About
=====
This extensions allows you to track generated html files
with Google Analytics web service.
Installing from sphinx-contrib checkout
---------------------------------------
Checkout googleanalytics sphinx extension::
$ git clone https://github.com/sphinx-contrib/googleanalytics
Change into the googleanalytics directory::
$ cd 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']
Configuration
-------------
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/
|
