sphinxcontrib-googleanalytics


Namesphinxcontrib-googleanalytics JSON
Version 0.4 PyPI version JSON
download
home_pagehttps://github.com/sphinx-contrib/googleanalytics
SummarySphinx extension googleanalytics
upload_time2023-01-04 17:16:05
maintainer
docs_urlNone
authorDomen Kozar
requires_python
licenseBSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. -*- 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/


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sphinx-contrib/googleanalytics",
    "name": "sphinxcontrib-googleanalytics",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Domen Kozar",
    "author_email": "domen@dev.si",
    "download_url": "https://files.pythonhosted.org/packages/31/79/07e26d53ecf4e8ddf2c27e5076cd7540ef1285d215ab88ae6cf7eb75ce88/sphinxcontrib-googleanalytics-0.4.tar.gz",
    "platform": "any",
    "description": ".. -*- restructuredtext -*-\n\n===========================================\nGoogle Analytics extension for Sphinx\n===========================================\n\n:author: Domen Ko\u017ear <domen@dev.si>\n\n\nAbout\n=====\n\nThis extensions allows you to track generated html files\nwith Google Analytics web service.\n\n\nInstalling from sphinx-contrib checkout\n---------------------------------------\n\nCheckout googleanalytics sphinx extension::\n\n  $ git clone https://github.com/sphinx-contrib/googleanalytics\n\nChange into the googleanalytics directory::\n\n  $ cd googleanalytics\n\nInstall the module::\n\n  $ python setup.py install\n\n\nEnabling the extension in Sphinx_\n---------------------------------\n\nJust add ``sphinxcontrib.googleanalytics`` to the list of extensions in the ``conf.py``\nfile. For example::\n\n    extensions = ['sphinxcontrib.googleanalytics']\n\n\nConfiguration\n-------------\n\nFor now one optional configuration is added to Sphinx_. It can be set in\n``conf.py`` file:\n\n``googleanalytics_id`` <string>:\n\tUA id for your site, example::\n\t\tgoogleanalytics_id = 'UA-123-123-123'\n\n``googleanalytics_enabled`` <bool>:\n\tTrue by default, use it to turn off tracking.\n\n\n.. Links:\n.. _gnuplot: http://www.gnuplot.info/\n.. _Sphinx: http://sphinx.pocoo.org/\n\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Sphinx extension googleanalytics",
    "version": "0.4",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bf0d6cadda83ad0ac9deae6d152e0defcbaeca93bea2ed5f502f93ff9e8bc369",
                "md5": "027c1b7db76e821faefaf1243d2e00bd",
                "sha256": "a6574983f9a58e5864ec10d34dc99914c4d647108b22c9249c8f0038b0cb18b3"
            },
            "downloads": -1,
            "filename": "sphinxcontrib_googleanalytics-0.4-py3-none-any.whl",
            "has_sig": true,
            "md5_digest": "027c1b7db76e821faefaf1243d2e00bd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3430,
            "upload_time": "2023-01-04T17:16:04",
            "upload_time_iso_8601": "2023-01-04T17:16:04.189292Z",
            "url": "https://files.pythonhosted.org/packages/bf/0d/6cadda83ad0ac9deae6d152e0defcbaeca93bea2ed5f502f93ff9e8bc369/sphinxcontrib_googleanalytics-0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "317907e26d53ecf4e8ddf2c27e5076cd7540ef1285d215ab88ae6cf7eb75ce88",
                "md5": "a267c20096c4006bef6605e64cb3a4d3",
                "sha256": "4b19c1f0fce5df6c7da5633201b64a9e5b0cb3210a14fdb4134942ceee8c5d12"
            },
            "downloads": -1,
            "filename": "sphinxcontrib-googleanalytics-0.4.tar.gz",
            "has_sig": true,
            "md5_digest": "a267c20096c4006bef6605e64cb3a4d3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2920,
            "upload_time": "2023-01-04T17:16:05",
            "upload_time_iso_8601": "2023-01-04T17:16:05.614724Z",
            "url": "https://files.pythonhosted.org/packages/31/79/07e26d53ecf4e8ddf2c27e5076cd7540ef1285d215ab88ae6cf7eb75ce88/sphinxcontrib-googleanalytics-0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-04 17:16:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "sphinx-contrib",
    "github_project": "googleanalytics",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "sphinxcontrib-googleanalytics"
}
        
Elapsed time: 0.03879s