https://github.com/sphinx-contrib/googleanalytics
https://github.com/sphinx-contrib/googleanalytics
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sphinx-contrib/googleanalytics
- Owner: sphinx-contrib
- License: bsd-3-clause
- Created: 2017-09-28T14:14:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-02T21:54:44.000Z (8 months ago)
- Last Synced: 2025-02-26T19:11:48.898Z (2 months ago)
- Language: Python
- Size: 24.4 KB
- Stars: 21
- Watchers: 4
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. -*- restructuredtext -*-
===========================================
Google Analytics extension for Sphinx
===========================================
:author: Domen Kožar
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`` :
UA id for your site, example::
googleanalytics_id = 'UA-123-123-123'
``googleanalytics_enabled`` :
True by default, use it to turn off tracking.
.. Links:
.. _gnuplot: http://www.gnuplot.info/
.. _Sphinx: http://sphinx.pocoo.org/