Sphinx extension googleanalytics
Project Links
Meta
Author: Domen Kozar
Maintainer: Jelmer Vernooij
Classifiers
Development Status
- 4 - Beta
Environment
- Console
- Web Environment
Intended Audience
- Developers
Operating System
- OS Independent
Programming Language
- Python
Topic
- Documentation
- Utilities
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.
Wheel compatibility matrix
Files in release
Extras:
None
Dependencies:
Sphinx
(>=0.6)