{
    "info": {
        "author": "Manuel Kaufmann",
        "author_email": "humitos@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "================================\nSphinx Version Warning Extension\n================================\n\n\nSphinx Version Warning is a Sphinx_ extension that allows you to show a *Warning* banner at the top of your documentation.\nThe banner is shown based on the version that is displayed compared (using SemVer_) with the latest version on the server.\n\nThis extension was originally created to be compatible with `Read the Docs`_ API and currently it's the only backend that supports\n(inspired by https://github.com/rtfd/readthedocs.org/issues/3481#issuecomment-378000845)\n\n.. _Sphinx: http://www.sphinx-doc.org/\n.. _SemVer: https://semver.org/\n.. _Read the Docs: http://readthedocs.org/\n\n\nHow it works?\n-------------\n\nWhen visiting a page in Read the Docs that was built with this extension enabled,\nan AJAX request is done to the Read the Docs servers to retrieve all the **active versions** of the project.\nThese versions are compared against the one that we are reading and if it's an old version,\na *Warning* banner appears at the top of the page.\n\n\nExamples\n--------\n\n.. image:: warning-example.png\n\nThere is a live example living at Read the Docs:\n\n- `latest`_ version doesn't show any kind of warning banner\n- `0.0.1`_ version shows a custom message for this particular version\n- `0.0.2`_ version shows a warning banner saying that 0.0.4 is available (at the time of writing this docs)\n- `0.0.4`_ version doesn't show any banner since it's the latest version (at the time of writing this docs)\n\n\n.. _latest: https://sphinx-version-warning-example.readthedocs.io/en/latest/\n.. _0.0.1: https://sphinx-version-warning-example.readthedocs.io/en/0.0.1/\n.. _0.0.2: https://sphinx-version-warning-example.readthedocs.io/en/0.0.2/\n.. _0.0.4: https://sphinx-version-warning-example.readthedocs.io/en/0.0.4/\n\n\nInstallation\n------------\n\nJust run this ``pip`` command inside your virtualenv::\n\n   pip install sphinx-version-warning\n\n\nThen in your ``conf.py`` you have to add ``versionwarning.extension`` in the ``extensions`` list.\nShould be similar to::\n\n  extensions = [\n      'versionwarning.extension',\n  ]\n\n\nRemember to configure the ``versionwarning_project_version`` and ``versionwarning_project_slug`` of your Sphinx project since it's the key for this to work properly::\n\n  versionwarning_project_version = '0.0.1'\n  versionwarning_project_slug = 'sphinx-version-warning'\n\n.. warning::\n\n   If you are building your documentation under Read the Docs,\n   ``READTHEDOCS_VERSION`` and ``READTHEDOCS_PROECT`` environment variables will be defined and there is no need to define these variables,\n   unless you want to override the default values.\n\n\nCustomization\n-------------\n\nSome customization can be done using the ``conf.py`` file of your Sphinx project:\n\nversionwarning_admonition_type (string)\n   type of admonition for the banner (warning, admonition or note)\n\nversionwarning_default_message (string)\n   default message for the warning banner\n\nversionwarning_messages (dict)\n   mapping between versions and messages for its banners\n\nversionwarning_message_placeholder (string)\n   text to be replaced by the version number link from the message\n\nversionwarning_project_slug (string)\n   slug of the project under Read the Docs (default to ``READTHEDOCS_PROJECT`` environment variable)\n\nversionwarning_project_version (string)\n   slug of the version for the current documentation (default to ``READTHEDOCS_VERSION`` environment variable)\n\nversionwarning_api_url (string)\n   API URL to retrieve all versions for this project\n\nversionwarning_banner_html (string)\n   HTML code used for the banner shown\n\nversionwarning_banner_id_div (string)\n   HTML element ID used for the <div> inject as banner\n\nversionwarning_body_selector (string)\n   jQuery selector to find the body element in the page and *prepend* the banner\n\n\nHow to contribute?\n------------------\n\nPull Requests are always welcome!\n\nGenerate assets\n***************\n\n::\n\n    npm install\n    ./node_modules/.bin/webpack\n\n\nReleasing\n---------\n\n#. Increment the version in ``versionwarning/__init__.py``\n#. Increment the version in ``package.json``\n#. Update the ``CHANGELOG.rst``\n#. Update ``npm``::\n\n     $ npm update\n\n#. Compile assets::\n\n     $ npm install\n     $ ./node_modules/.bin/webpack\n\n#. Commit the changes: ``git commit -m \"Release $NEW_VERSION\"``\n#. Tag the release in git: ``git tag $NEW_VERSION``\n#. Push the tag to GitHub: ``git push --tags origin``\n#. Upload the package to PyPI::\n\n     $ rm -rf dist/\n     $ python setup.py sdist bdist_wheel\n     $ twine upload dist/*\n\n\n",
        "description_content_type": "text/x-rst",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/humitos/sphinx-version-warning",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sphinx-version-warning",
        "package_url": "https://pypi.org/project/sphinx-version-warning/",
        "platform": "",
        "project_url": "https://pypi.org/project/sphinx-version-warning/",
        "project_urls": {
            "Homepage": "https://github.com/humitos/sphinx-version-warning"
        },
        "release_url": "https://pypi.org/project/sphinx-version-warning/1.1.2/",
        "requires_dist": [
            "sphinx"
        ],
        "requires_python": "",
        "summary": "Sphinx extension to add a warning banner",
        "version": "1.1.2"
    },
    "last_serial": 4446502,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a74832eb7d530252099916a10a0cb874",
                    "sha256": "836ccee76c4ed3357cbc8ae5af7d3263d5a7a47dce722cbfbf624cec622097e7"
                },
                "downloads": -1,
                "filename": "sphinx_version_warning-0.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a74832eb7d530252099916a10a0cb874",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10760,
                "upload_time": "2018-07-28T03:06:39",
                "url": "https://files.pythonhosted.org/packages/e5/8d/72a903aa589fec63c7387552ec1b1766565f60df2f20d1449adf6420de5d/sphinx_version_warning-0.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "78dbedbe8a61fff6d5662c6962dbc05f",
                    "sha256": "9139a8e3b8e0b19d30461753adfb34a71fb2ebcd5e07cf42842c7980e7f9735c"
                },
                "downloads": -1,
                "filename": "sphinx-version-warning-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "78dbedbe8a61fff6d5662c6962dbc05f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10966,
                "upload_time": "2018-07-28T03:06:40",
                "url": "https://files.pythonhosted.org/packages/90/93/ab64ce054e2e63cb052883469bf776c5df7a5a61f683c331e5c1d8de566e/sphinx-version-warning-0.0.1.tar.gz"
            }
        ],
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "eb9dc8f2360c81ba01316bac133dff0d",
                    "sha256": "7d2e540fc533dbb21fdf6fd634e2b92b9e026366fb9d65d3c0a0c7369c455a25"
                },
                "downloads": -1,
                "filename": "sphinx_version_warning-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "eb9dc8f2360c81ba01316bac133dff0d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 12422,
                "upload_time": "2018-07-30T00:13:52",
                "url": "https://files.pythonhosted.org/packages/5b/c6/9af5ea063a32b641c31d0ef06b73f209be27e46083eed3bde4782957fe4c/sphinx_version_warning-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ff7d83a40ef659eae7387aa349d9f400",
                    "sha256": "5a889936a404a20069c1c88182c961ebf9779c6eeacd2b9f26d5dbd7203b483b"
                },
                "downloads": -1,
                "filename": "sphinx-version-warning-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "ff7d83a40ef659eae7387aa349d9f400",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12318,
                "upload_time": "2018-07-30T00:13:53",
                "url": "https://files.pythonhosted.org/packages/3d/60/2a702a1ca022dea8a8a0e00b6564a44787b059c45b5169b8e6a621ed1ac9/sphinx-version-warning-0.1.0.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4035a1fb75d17b2870fe12b1cbc4a2fd",
                    "sha256": "f94e83b9502d7b61b48e190b82556d9ccad84cfdc42e6c744b6126d7ff3d35ca"
                },
                "downloads": -1,
                "filename": "sphinx_version_warning-0.2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "4035a1fb75d17b2870fe12b1cbc4a2fd",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 12592,
                "upload_time": "2018-07-30T14:34:18",
                "url": "https://files.pythonhosted.org/packages/ee/19/65272e24eb1873ef613d808d9134d0f52a1700b6dd32f8d640c4932eecd5/sphinx_version_warning-0.2.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "1d1f576a18a64ccd676fbdee23f7db40",
                    "sha256": "bb2ff8e94b501cb2af63a3f261b75c76d7beed9fd63bc275d6c4d49e2fb83369"
                },
                "downloads": -1,
                "filename": "sphinx-version-warning-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "1d1f576a18a64ccd676fbdee23f7db40",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12524,
                "upload_time": "2018-07-30T14:34:20",
                "url": "https://files.pythonhosted.org/packages/27/12/7c7408bb315779f3c283d6b706a8a36c84045269d4c7b43a18d9fccc6524/sphinx-version-warning-0.2.0.tar.gz"
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a8eb2332d4246fcdbd6e1d0a5adae00c",
                    "sha256": "9c0bb3b5f9ca0fd9943fa03ec273bd2f3eb0584b927971ae830942c1fb082e84"
                },
                "downloads": -1,
                "filename": "sphinx_version_warning-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a8eb2332d4246fcdbd6e1d0a5adae00c",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 13448,
                "upload_time": "2018-10-21T20:11:08",
                "url": "https://files.pythonhosted.org/packages/7e/7d/369616b1f8280a4c8b1bb7d112c9cb5a88893afc2fd02a196706b95d644b/sphinx_version_warning-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "659dfdfd7aa197ca5c14c52c17af6957",
                    "sha256": "f16d5415ae7dbd88997fd6d63556e91f7e7ea0f4a5b211c75a0bd3b6dd0e54b4"
                },
                "downloads": -1,
                "filename": "sphinx-version-warning-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "659dfdfd7aa197ca5c14c52c17af6957",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11914,
                "upload_time": "2018-10-21T20:11:10",
                "url": "https://files.pythonhosted.org/packages/11/54/5bd4f0b67f61b8a7bb6f10e02dcce6eb21f47a76ab8c311edbaa5ce3f04a/sphinx-version-warning-1.0.0.tar.gz"
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c0a9bcc462ac76df43ff87c32deca428",
                    "sha256": "50f0b3bd298d5ae9b28e06392f49f7a3b689549e145e241feef81b2418d694ee"
                },
                "downloads": -1,
                "filename": "sphinx_version_warning-1.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c0a9bcc462ac76df43ff87c32deca428",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 13460,
                "upload_time": "2018-10-22T14:18:16",
                "url": "https://files.pythonhosted.org/packages/73/87/913f70a0f6bf195e14dfa96b45a5afa1a3a6f06343f41c1fdf4c376a6fc0/sphinx_version_warning-1.0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "bcfb5c5f599ea612a1516d997d50798e",
                    "sha256": "e85c2b09b5d1ffb1c05baac256c9fb93e915e12d825a80546a47c27efbb03644"
                },
                "downloads": -1,
                "filename": "sphinx-version-warning-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "bcfb5c5f599ea612a1516d997d50798e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11981,
                "upload_time": "2018-10-22T14:18:17",
                "url": "https://files.pythonhosted.org/packages/6e/38/b42a1bb7c993f510feebf65911e75fbb1b3be90e4d8bfbe98318a9f0fc29/sphinx-version-warning-1.0.2.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7032e987b00a3b3c9ec48259ebfc22f5",
                    "sha256": "a7d1e96ace5f74141643c3fcdecfe7ddb82dd3e4dde440c584e04f6e1242855a"
                },
                "downloads": -1,
                "filename": "sphinx_version_warning-1.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "7032e987b00a3b3c9ec48259ebfc22f5",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 13512,
                "upload_time": "2018-10-31T11:18:51",
                "url": "https://files.pythonhosted.org/packages/40/44/93cba19a082a06cf17fe9e03cb0ad63bd6b2666bfd632b7209023b716019/sphinx_version_warning-1.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d727da598c2311ce9347079952668304",
                    "sha256": "7146cce83cd0045e96e6d8013000938cbeb0bd5147e9ac37aa4e010f0d1798e2"
                },
                "downloads": -1,
                "filename": "sphinx-version-warning-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "d727da598c2311ce9347079952668304",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12101,
                "upload_time": "2018-10-31T11:18:52",
                "url": "https://files.pythonhosted.org/packages/a1/17/5abbb6f52d6b4849334f368e1d8e0758b3f6a9ef7024a9a03774e08cb9eb/sphinx-version-warning-1.1.0.tar.gz"
            }
        ],
        "1.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2e4308c9784e24e8a852749e6b698fb1",
                    "sha256": "5e8c240db1c1f29ecf936cfb58bdd84af329d3c8169d4df2b2d7c61321ca3d48"
                },
                "downloads": -1,
                "filename": "sphinx_version_warning-1.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2e4308c9784e24e8a852749e6b698fb1",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 13513,
                "upload_time": "2018-10-31T16:30:00",
                "url": "https://files.pythonhosted.org/packages/f0/f2/ae4248754adcb2201b062faa11717322e9d41d9c46da26fa6916e842fa7b/sphinx_version_warning-1.1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "74c4dbad196a1b2c5436b4cdda7c92c7",
                    "sha256": "2663bf58a60845f2cc9e038875151816eb27322a6b4ff2c3d494e3bb2bc5c1ec"
                },
                "downloads": -1,
                "filename": "sphinx-version-warning-1.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "74c4dbad196a1b2c5436b4cdda7c92c7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12139,
                "upload_time": "2018-10-31T16:30:02",
                "url": "https://files.pythonhosted.org/packages/5e/2c/3ca83eab03e915629ccec5b94c6aed1b18093997e284ef0edd6c3c9424dc/sphinx-version-warning-1.1.1.tar.gz"
            }
        ],
        "1.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7bece65cc10f63ec5e3006978141c09c",
                    "sha256": "e015947fe7af6c4ba2ce08bb346b1eb822d9dbd797a748757366905f8ce623f1"
                },
                "downloads": -1,
                "filename": "sphinx_version_warning-1.1.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "7bece65cc10f63ec5e3006978141c09c",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 13578,
                "upload_time": "2018-11-03T00:46:33",
                "url": "https://files.pythonhosted.org/packages/55/1a/10984258c3524c9b29b7552fe629a9741c141712dc79c476606e4fe5edac/sphinx_version_warning-1.1.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b17e016b32add34e5deaa80b4a9af799",
                    "sha256": "9924926fd3e739e32eb42ba2db092ecd7657200107146944fb3e440c9651d945"
                },
                "downloads": -1,
                "filename": "sphinx-version-warning-1.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "b17e016b32add34e5deaa80b4a9af799",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12240,
                "upload_time": "2018-11-03T00:46:35",
                "url": "https://files.pythonhosted.org/packages/53/13/c289394ce20fbd02a1914d44ad28caf26494387ecd2bdaa989a1b069c9ac/sphinx-version-warning-1.1.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "7bece65cc10f63ec5e3006978141c09c",
                "sha256": "e015947fe7af6c4ba2ce08bb346b1eb822d9dbd797a748757366905f8ce623f1"
            },
            "downloads": -1,
            "filename": "sphinx_version_warning-1.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7bece65cc10f63ec5e3006978141c09c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 13578,
            "upload_time": "2018-11-03T00:46:33",
            "url": "https://files.pythonhosted.org/packages/55/1a/10984258c3524c9b29b7552fe629a9741c141712dc79c476606e4fe5edac/sphinx_version_warning-1.1.2-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "b17e016b32add34e5deaa80b4a9af799",
                "sha256": "9924926fd3e739e32eb42ba2db092ecd7657200107146944fb3e440c9651d945"
            },
            "downloads": -1,
            "filename": "sphinx-version-warning-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "b17e016b32add34e5deaa80b4a9af799",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12240,
            "upload_time": "2018-11-03T00:46:35",
            "url": "https://files.pythonhosted.org/packages/53/13/c289394ce20fbd02a1914d44ad28caf26494387ecd2bdaa989a1b069c9ac/sphinx-version-warning-1.1.2.tar.gz"
        }
    ]
}