Metadata-Version: 1.1
Name: sphinxcontrib-googleanalytics
Version: 0.1.dev20171010
Summary: Sphinx extension googleanalytics
Home-page: http://bitbucket.org/birkenfeld/sphinx-contrib
Author: Domen Kozar
Author-email: domen@dev.si
License: BSD
Download-URL: http://pypi.python.org/pypi/sphinxcontrib-googleanalytics
Description-Content-Type: UNKNOWN
Description: .. -*- 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 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']
        
        
        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/
        
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
