{
    "info": {
        "author": "Zeit Online",
        "author_email": "zon-backend@zeit.de",
        "bugtrack_url": null,
        "classifiers": [
            "Programming Language :: Python :: 3"
        ],
        "description": "====================\nsphinx_elasticsearch\n====================\n\nIndexes a documentation project build via `Sphinx`_ into elasticsearch.\nThis is a stand-alone extraction of the functionality used by readthedocs.org,\ncompatible with elasticsearch-6.\n\n.. _`sphinx`: https://www.sphinx-doc.org/\n\n\nUsage\n=====\n\nSet up:\n\n* Install `elasticsearch`_\n* Install the package: ``virtualenv --python=python3 .; bin/pip install sphinx_elasticsearch``\n* Create index:\n  ``bin/sphinx-elasticsearch create-index --es-url=http://localhost:9200 --replicas=1 --shards=5``\n  ``bin/sphinx-elasticsearch put-mapping --es-url=http://localhost:9200``\n\nBy default we use an index named ``docs`` and a document type ``page``, you can customize this via the ``--index`` and ``--type`` parameters (but you'll need to pass them to all three commands, create-index, put-mapping and index).\n\nNote that you'll probably be better off managing index creation and mapping setup yourself; these two setup commands are more for getting started quickly and out of the box.\n\nIndex your sphinx project:\n\n* Build your project as JSON (for easier parsing): ``bin/sphinx-build -b json . json-build``\n* Index into ES: ``bin/sphinx-elasticsearch index --es-url=http://localhost:9200 --index=docs json-build``\n  (If you pass ``--commit`` any previously indexed pages that have been deleted will be removed automatically.)\n\n\n.. _`elasticsearch`: https://www.elastic.co/products/elasticsearch\n\n\nElasticsearch Mapping\n=====================\n\n:project: Short name of the project. Clients will use this to construct URLs.\n:path: Relative path of the page, without extension.\n:id: Unique identifier (hash of ``project`` and ``path``)\n:commit: Optional, to allow deleting deleted pages on subsequent index runs.\n:title: Title of the page\n:headers: List of all headers on the page\n:content: Body of the page (any HTML markup is stripped by ES)\n\n\nsphinx_elasticsearch changes\n============================\n\n1.0.1 (2018-12-11)\n------------------\n\n- Flush after indexing and before deleting, to prevent conflict errors\n\n\n1.0.0 (2018-12-09)\n------------------\n\n- Initial release",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/zeitonline/sphinx_elasticsearch",
        "keywords": "",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sphinx-elasticsearch",
        "package_url": "https://pypi.org/project/sphinx-elasticsearch/",
        "platform": "",
        "project_url": "https://pypi.org/project/sphinx-elasticsearch/",
        "project_urls": {
            "Homepage": "https://github.com/zeitonline/sphinx_elasticsearch"
        },
        "release_url": "https://pypi.org/project/sphinx-elasticsearch/1.0.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Indexes documentation build via Sphinx into elasticsearch",
        "version": "1.0.1"
    },
    "last_serial": 4584253,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "caa5947fd6c5eca29107ea2fadb8957c",
                    "sha256": "bd236a346ccd3231aa543e2066b91aeb841bd44ed65f06d392f7b47f493757b9"
                },
                "downloads": -1,
                "filename": "sphinx_elasticsearch-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "caa5947fd6c5eca29107ea2fadb8957c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9404,
                "upload_time": "2018-12-09T13:45:38",
                "url": "https://files.pythonhosted.org/packages/41/73/f724de440b714601b2e2c300f3e1ce07084f06437c3abc70ae0f621582e5/sphinx_elasticsearch-1.0.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6bb78c7f4cfdf20b626380015f7d17c8",
                    "sha256": "a4143838a99b1e9109412c6c7c154adb7e57ea5ebe4010e77f0dd667a43a5562"
                },
                "downloads": -1,
                "filename": "sphinx_elasticsearch-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "6bb78c7f4cfdf20b626380015f7d17c8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9485,
                "upload_time": "2018-12-11T08:15:32",
                "url": "https://files.pythonhosted.org/packages/a5/7a/0a2504071b8aa4b24ac114083dc259719a40951e2a4f7fa7ec5c51a8a7d7/sphinx_elasticsearch-1.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6bb78c7f4cfdf20b626380015f7d17c8",
                "sha256": "a4143838a99b1e9109412c6c7c154adb7e57ea5ebe4010e77f0dd667a43a5562"
            },
            "downloads": -1,
            "filename": "sphinx_elasticsearch-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6bb78c7f4cfdf20b626380015f7d17c8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9485,
            "upload_time": "2018-12-11T08:15:32",
            "url": "https://files.pythonhosted.org/packages/a5/7a/0a2504071b8aa4b24ac114083dc259719a40951e2a4f7fa7ec5c51a8a7d7/sphinx_elasticsearch-1.0.1.tar.gz"
        }
    ]
}