{
"info": {
"author": "Timotheus Kampik",
"author_email": "timotheus.kampik@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Environment :: Plugins",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Topic :: Documentation"
],
"description": ".. image:: https://travis-ci.org/TimKam/sphinx-pretty-searchresults.svg?branch=master\r\n :target: https://travis-ci.org/TimKam/sphinx-pretty-searchresults\r\n\r\n\r\nSphinx: pretty search results\r\n=============================\r\n*Sphinx: pretty search results* is an extension for the\r\n`Sphinx documentation tool `__.\r\n\r\nTo display search results, Sphinx is fetching the source files of search hits and rendering excerpts in raw markup\r\n(`Example `__).\r\n\r\nThis extension removes the markup from these source files (during build time), so the search results look decent.\r\n\r\n\r\nInstallation\r\n------------\r\nRun ``pip install sphinxprettysearchresults``.\r\n\r\n\r\nConfiguration\r\n-------------\r\nAfter installing the extension, all you need to do is to register it.\r\n\r\nAdd ``sphinxprettysearchresults`` to the ``extensions`` array in your ``conf.py`` file, for example::\r\n\r\n extensions = [\r\n 'sphinxprettysearchresults'\r\n ]\r\n\r\nAfter your next build, your project will no longer display raw markup in the search result excerpts.\r\n\r\nSince version 1.5.0, Sphinx is adding the source file extension to the source files it includes in the output folder.\r\nFor example, when your source file extension is `rst` (specified in the config variable `source_suffix` as `[.rst]`,\r\nyour index file appears in the output's source folder as `index.rst.txt`. If you use a Sphinx version lower than 1.5.0,\r\nit appears as `index.txt`. *Sphinx: pretty search results* considers this difference and changes its behavior according\r\nto your Sphinx version. However, if you use a Sphinx theme that expects the old file names although you are using a\r\nlater Sphinx version, you can fall back to the old file names by setting the following configuration variable::\r\n\r\n use_old_search_snippets = True\r\n\r\n\r\nSource links\r\n------------\r\nBy default Sphinx copies the source files into the build's `_sources` directory and uses it for both search snippets and\r\n- if `activated `_ - source links.\r\n*Sphinx: pretty search results* uses the `_sources` directory for the prettified text snippets and moves the raw sources\r\n(for the source links) into its own `_raw_sources` directory. On build time, it overwrites the `sourcelink.html`\r\ntemplate to reference the files in `_raw_sources`. If you want to use the extension with a custom source link, you need\r\nto adjust it to point to `_raw_sources` instead of `_sources`.\r\n\r\nTesting\r\n-------\r\n*Sphinx: pretty search results* uses `nose `__ as its test framework.\r\n\r\nTo run the tests, you first need to install the dev dependencies::\r\n\r\n pip install -r dev_requirements.txt\r\n\r\nThen, navigate to the ``tests`` directory and run::\r\n\r\n python run.py\r\n\r\n",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/TimKam/sphinx-pretty-searchresults",
"keywords": "",
"license": "MIT",
"maintainer": "",
"maintainer_email": "",
"name": "sphinxprettysearchresults",
"package_url": "https://pypi.org/project/sphinxprettysearchresults/",
"platform": "any",
"project_url": "https://pypi.org/project/sphinxprettysearchresults/",
"project_urls": {
"Homepage": "https://github.com/TimKam/sphinx-pretty-searchresults"
},
"release_url": "https://pypi.org/project/sphinxprettysearchresults/0.3.5/",
"requires_dist": null,
"requires_python": "",
"summary": "Decently styled search results for sphinx-doc projects",
"version": "0.3.5"
},
"last_serial": 3815360,
"releases": {
"0.1": [
{
"comment_text": "",
"digests": {
"md5": "d26cdcad0358825f7af161be2ac5981d",
"sha256": "984435d768044ac4df9e6201c80849c8029880849d2773fdca274158fbef6b11"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.1.tar.gz",
"has_sig": false,
"md5_digest": "d26cdcad0358825f7af161be2ac5981d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2365,
"upload_time": "2016-07-30T21:31:33",
"url": "https://files.pythonhosted.org/packages/c2/0b/796c717a176f9d948645e5a488c5fafdeffba52b68d426c8ff2f2ac418f1/sphinxprettysearchresults-0.1.tar.gz"
}
],
"0.1.1": [
{
"comment_text": "",
"digests": {
"md5": "50bbb715b4981a80a96ceebafe502b2d",
"sha256": "58b449c447b976b733aa7ad382c48da0176f885adb555910e9007390fb2879e6"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "50bbb715b4981a80a96ceebafe502b2d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3088,
"upload_time": "2016-07-30T22:35:47",
"url": "https://files.pythonhosted.org/packages/d6/d8/99f540552076882a67272c7e24f725e282436104b1a76c474a0e5f89db13/sphinxprettysearchresults-0.1.1.tar.gz"
}
],
"0.1.2": [
{
"comment_text": "",
"digests": {
"md5": "5527f0764183c56b32e64ac3304c5aaf",
"sha256": "7a9e24ddc1dacd58a2bb7170e7709b51e622e9fd32d007970e3933aa1deaa784"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "5527f0764183c56b32e64ac3304c5aaf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3097,
"upload_time": "2016-08-02T20:12:03",
"url": "https://files.pythonhosted.org/packages/a3/39/bdc32f5bc23818c175b96e8925ae5300a3926c6638477debf11c1ed88d15/sphinxprettysearchresults-0.1.2.tar.gz"
}
],
"0.1.3": [],
"0.1.4": [
{
"comment_text": "",
"digests": {
"md5": "eaeb35272215ca6f569a183a0d23f8d8",
"sha256": "ea9ed3164ff1be63db611ac1116efb784812b84f7c8449306e0ccb027c621653"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "eaeb35272215ca6f569a183a0d23f8d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3243,
"upload_time": "2016-08-29T21:08:50",
"url": "https://files.pythonhosted.org/packages/19/ba/b89bf08250c2d37c103c919a5aa5f935555c903400b81c2f64ad7cf2c5fb/sphinxprettysearchresults-0.1.4.tar.gz"
}
],
"0.1.5": [
{
"comment_text": "",
"digests": {
"md5": "0cf37b2f9b408a9629b3035bef93215b",
"sha256": "ffe71feef292951cc4a04046ad989f9e33629d720c08f547ed322e6ccc5a45a9"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "0cf37b2f9b408a9629b3035bef93215b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3189,
"upload_time": "2016-09-04T21:18:18",
"url": "https://files.pythonhosted.org/packages/b9/50/c2ec461d96a8b20d7716d7484eb0db2faf246d209ad814aa3b141309d451/sphinxprettysearchresults-0.1.5.tar.gz"
}
],
"0.1.6": [
{
"comment_text": "",
"digests": {
"md5": "a5b27a05a247d79c5eecf1f1f16cdcc3",
"sha256": "dc056d37fec32acb8c90f212bd480d3041c50c8b87fd50579d7c73b6c0ac587f"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "a5b27a05a247d79c5eecf1f1f16cdcc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3210,
"upload_time": "2016-09-13T22:00:34",
"url": "https://files.pythonhosted.org/packages/ac/9d/fff7fe656ff28108344cff46f1bd19de0d01af57b462da83d743ef19f076/sphinxprettysearchresults-0.1.6.tar.gz"
}
],
"0.1.7": [
{
"comment_text": "",
"digests": {
"md5": "d62c25884065e2ee8e6fa020311db3dc",
"sha256": "cfab75dd5c337b2635e85820f474fd233fc267b63d0fe00ec5f75b7cffd4c82f"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "d62c25884065e2ee8e6fa020311db3dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3278,
"upload_time": "2016-10-03T09:36:46",
"url": "https://files.pythonhosted.org/packages/d5/af/71fbdd857b760e56f4c3a7946c1f0f67659bb411f58955a1dbd325a44e03/sphinxprettysearchresults-0.1.7.tar.gz"
}
],
"0.2.0": [
{
"comment_text": "",
"digests": {
"md5": "894fdb194b79ce86eb07015aa2a01d67",
"sha256": "438b48247bc7b65895b72c68590c948da63d6d59b7c94bdb3a9714c29f3a40c4"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "894fdb194b79ce86eb07015aa2a01d67",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3730,
"upload_time": "2017-05-13T17:42:25",
"url": "https://files.pythonhosted.org/packages/03/2c/be5e3edda4c82357840f68c686da41f2b9ef474f0e6dca0749daddabf7f6/sphinxprettysearchresults-0.2.0.tar.gz"
}
],
"0.3.0": [
{
"comment_text": "",
"digests": {
"md5": "b2ed7e900693d5b5594d12a78edb72fb",
"sha256": "81df1934d897ab649e6c91ce7051c5ce26ca55503cd2550812fe51a428bb6084"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "b2ed7e900693d5b5594d12a78edb72fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4092,
"upload_time": "2017-05-22T22:13:37",
"url": "https://files.pythonhosted.org/packages/c6/fd/87f1972bd013f9f8badc5bd6498928c0015b7b752dbcf4508c940576417e/sphinxprettysearchresults-0.3.0.tar.gz"
}
],
"0.3.1": [
{
"comment_text": "",
"digests": {
"md5": "2c63bc049cc8e96a371a87b56cadca0f",
"sha256": "f0de79d9c8ff4661ea30dc2dde711804c9af59027141a57d061b4e6168589822"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "2c63bc049cc8e96a371a87b56cadca0f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4136,
"upload_time": "2017-06-19T16:59:07",
"url": "https://files.pythonhosted.org/packages/38/28/2bc2eae015161321e02c5ebd24f38275be34529f70967f0e9f44bf3b37bb/sphinxprettysearchresults-0.3.1.tar.gz"
}
],
"0.3.2": [
{
"comment_text": "",
"digests": {
"md5": "e8986351922df2817ba5e75a3a2418b9",
"sha256": "60aa80c34744a9d1102edb44ebeb37b3a703a167f3ebe2b551b73e8290f99385"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "e8986351922df2817ba5e75a3a2418b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4206,
"upload_time": "2017-08-22T21:28:09",
"url": "https://files.pythonhosted.org/packages/12/bd/3518f7a3b10edce915f3e085ed9ee47c3d37ec302395b10547c908c93e64/sphinxprettysearchresults-0.3.2.tar.gz"
}
],
"0.3.3": [
{
"comment_text": "",
"digests": {
"md5": "5061c4e59d69e726afa10b31f3d1d0e9",
"sha256": "0dc02c547c519decf1b6a06f7d58b216fb82cfc026db0faf28c4c877b6da1418"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "5061c4e59d69e726afa10b31f3d1d0e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4228,
"upload_time": "2018-02-23T21:55:50",
"url": "https://files.pythonhosted.org/packages/4e/3e/a20b9d35b19fd243eecd35bf035d78c8ac488066bdd12cb17e83ce98a370/sphinxprettysearchresults-0.3.3.tar.gz"
}
],
"0.3.4": [
{
"comment_text": "",
"digests": {
"md5": "58c385184e949d7dfd45f6dd8048c228",
"sha256": "2a081f93233dc3ec23366958531fb0151ca4fc7e9389c6f6dbc9bd8c7010af5b"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "58c385184e949d7dfd45f6dd8048c228",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4402,
"upload_time": "2018-03-30T10:55:06",
"url": "https://files.pythonhosted.org/packages/c5/11/a36668824a1fba877cca11012d1640b882afc610effa83e8c8776e727012/sphinxprettysearchresults-0.3.4.tar.gz"
}
],
"0.3.5": [
{
"comment_text": "",
"digests": {
"md5": "305254a8c85df82c69f8c0d9604fc038",
"sha256": "bc1c306b5c2ceadb264d9daa880b2e7aab82322e9d4dd5f876ec62f4e173d369"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "305254a8c85df82c69f8c0d9604fc038",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4432,
"upload_time": "2018-04-27T21:17:59",
"url": "https://files.pythonhosted.org/packages/64/f3/4ac2518dc6e1556240351d3d10d59ed315e65f64e8fa6289535af1be0a6f/sphinxprettysearchresults-0.3.5.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "305254a8c85df82c69f8c0d9604fc038",
"sha256": "bc1c306b5c2ceadb264d9daa880b2e7aab82322e9d4dd5f876ec62f4e173d369"
},
"downloads": -1,
"filename": "sphinxprettysearchresults-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "305254a8c85df82c69f8c0d9604fc038",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4432,
"upload_time": "2018-04-27T21:17:59",
"url": "https://files.pythonhosted.org/packages/64/f3/4ac2518dc6e1556240351d3d10d59ed315e65f64e8fa6289535af1be0a6f/sphinxprettysearchresults-0.3.5.tar.gz"
}
]
}