| Name | sphinx-docsearch JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A Sphinx extension for replacing the built-in search with Algolia DocSearch |
| upload_time | 2024-10-04 12:04:40 |
| maintainer | None |
| docs_url | None |
| author | Algolia |
| requires_python | <4.0,>=3.8 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Algolia DocSearch for Sphinx
This extension for the [Sphinx](https://www.sphinx-doc.org/en/master/) documentation generator
replaces Sphinx's built-in search with Algolia DocSearch.
## Before you begin
[**Apply for DocSearch**](https://docsearch.algolia.com/apply).
You'll get an email with your Algolia credentials.
This extension supports Python versions 3.8 and later and Sphinx versions 5 and later.
For a list of supported themes, see [HTML theme support](https://sphinx-docsearch.readthedocs.io/themes.html)
## Install
Install the `sphinx-docsearch` package:
```sh
pip install sphinx-docsearch
```
## Configure
1. Add `sphinx-docsearch` to your Sphinx configuration:
```python
# conf.py
extensions += ["sphinx_docsearch"]
```
1. Add your Algolia credentials to your Sphinx configuration:
```python
# conf.py
docsearch_app_id = "<DOCSEARCH_APP_ID>"
docsearch_api_key = "<DOCSEARCH_SEARCH_API_KEY>"
docsearch_index_name = "<DOCSEARCH_INDEX_NAME>"
```
See also:
- [Manage credentials](https://sphinx-docsearch.readthedocs.io/credentials.html)
- [Configure DocSearch](https://sphinx-docsearch.readthedocs.io/configuration.html)
## Customize
To change what the crawler should extract from your pages,
see [Record Extractor](https://docsearch.algolia.com/docs/record-extractor).
If you're using a Sphinx theme that's not supported,
you can add custom templates to add the DocSearch UI.
You can further customize the look of the DocSearch UI by adding custom CSS.
For more information, see [Customize](https://sphinx-docsearch.readthedocs.io/customization.html).
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-docsearch",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Algolia",
"author_email": "support@algolia.com",
"download_url": "https://files.pythonhosted.org/packages/7c/3c/52eb72d3e837f269aed90b0ef1b4f7dd437d26cc6812209f839c91053d8f/sphinx_docsearch-0.1.0.tar.gz",
"platform": null,
"description": "# Algolia DocSearch for Sphinx\n\nThis extension for the [Sphinx](https://www.sphinx-doc.org/en/master/) documentation generator\nreplaces Sphinx's built-in search with Algolia DocSearch.\n\n## Before you begin\n\n[**Apply for DocSearch**](https://docsearch.algolia.com/apply).\nYou'll get an email with your Algolia credentials.\n\nThis extension supports Python versions 3.8 and later and Sphinx versions 5 and later.\n\nFor a list of supported themes, see [HTML theme support](https://sphinx-docsearch.readthedocs.io/themes.html)\n\n## Install\n\nInstall the `sphinx-docsearch` package:\n\n```sh\npip install sphinx-docsearch\n```\n\n## Configure\n\n1. Add `sphinx-docsearch` to your Sphinx configuration:\n\n ```python\n # conf.py\n extensions += [\"sphinx_docsearch\"]\n ```\n\n1. Add your Algolia credentials to your Sphinx configuration:\n\n ```python\n # conf.py\n docsearch_app_id = \"<DOCSEARCH_APP_ID>\"\n docsearch_api_key = \"<DOCSEARCH_SEARCH_API_KEY>\"\n docsearch_index_name = \"<DOCSEARCH_INDEX_NAME>\"\n ```\n\n See also:\n\n - [Manage credentials](https://sphinx-docsearch.readthedocs.io/credentials.html)\n - [Configure DocSearch](https://sphinx-docsearch.readthedocs.io/configuration.html)\n\n## Customize\n\nTo change what the crawler should extract from your pages,\nsee [Record Extractor](https://docsearch.algolia.com/docs/record-extractor).\n\nIf you're using a Sphinx theme that's not supported,\nyou can add custom templates to add the DocSearch UI.\nYou can further customize the look of the DocSearch UI by adding custom CSS.\nFor more information, see [Customize](https://sphinx-docsearch.readthedocs.io/customization.html).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Sphinx extension for replacing the built-in search with Algolia DocSearch",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b444e59ba1820e8190d1cb3bceb491d875da5f79fb3f61f5c2fe82037c3546e",
"md5": "1e7ac07c05f30ca746f06aac33311aa7",
"sha256": "799221b0b962e3d86d0e0f084d4998c3d9227ef0eb2883d70e41d6bd08b616dd"
},
"downloads": -1,
"filename": "sphinx_docsearch-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1e7ac07c05f30ca746f06aac33311aa7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 41852,
"upload_time": "2024-10-04T12:04:38",
"upload_time_iso_8601": "2024-10-04T12:04:38.933399Z",
"url": "https://files.pythonhosted.org/packages/2b/44/4e59ba1820e8190d1cb3bceb491d875da5f79fb3f61f5c2fe82037c3546e/sphinx_docsearch-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c3c52eb72d3e837f269aed90b0ef1b4f7dd437d26cc6812209f839c91053d8f",
"md5": "d23a9c0cd6472c253a5dcb027bdac488",
"sha256": "76fd0695e115b76ebb9633acffc263bfd894caad7aa29e3c40bfe3171da41535"
},
"downloads": -1,
"filename": "sphinx_docsearch-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d23a9c0cd6472c253a5dcb027bdac488",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 40008,
"upload_time": "2024-10-04T12:04:40",
"upload_time_iso_8601": "2024-10-04T12:04:40.757203Z",
"url": "https://files.pythonhosted.org/packages/7c/3c/52eb72d3e837f269aed90b0ef1b4f7dd437d26cc6812209f839c91053d8f/sphinx_docsearch-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-04 12:04:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-docsearch"
}
