| Name | sphinx-disqus JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | Embed Disqus comments in Sphinx documents/pages. |
| upload_time | 2024-07-07 17:49:28 |
| maintainer | None |
| docs_url | None |
| author | Robpol86 |
| requires_python | <4.0,>=3.9 |
| license | BSD-2-Clause |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sphinx-disqus
Embed [Disqus](https://disqus.com) comments in Sphinx documents/pages.
* Python 3.9 through 3.12 supported on Linux, macOS, and Windows.
📖 Full documentation: https://sphinx-disqus.readthedocs.io
[![Github-CI][github-ci]][github-link]
[![Coverage Status][codecov-badge]][codecov-link]
[![Documentation Status][rtd-badge]][rtd-link]
[![Code style: black][black-badge]][black-link]
[![PyPI][pypi-badge]][pypi-link]
[![PyPI Downloads][pypi-dl-badge]][pypi-dl-link]
[github-ci]: https://github.com/Robpol86/sphinx-disqus/actions/workflows/ci.yml/badge.svg?branch=main
[github-link]: https://github.com/Robpol86/sphinx-disqus/actions/workflows/ci.yml
[codecov-badge]: https://codecov.io/gh/Robpol86/sphinx-disqus/branch/main/graph/badge.svg
[codecov-link]: https://codecov.io/gh/Robpol86/sphinx-disqus
[rtd-badge]: https://readthedocs.org/projects/sphinx-disqus/badge/?version=latest
[rtd-link]: https://sphinx-disqus.readthedocs.io/en/latest/?badge=latest
[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-link]: https://github.com/ambv/black
[pypi-badge]: https://img.shields.io/pypi/v/sphinx-disqus.svg
[pypi-link]: https://pypi.org/project/sphinx-disqus
[pypi-dl-badge]: https://img.shields.io/pypi/dw/sphinx-disqus?label=pypi%20downloads
[pypi-dl-link]: https://pypistats.org/packages/sphinx-disqus
## Quickstart
To install run the following:
```bash
pip install sphinx-disqus
```
To use in Sphinx simply add to your `conf.py`:
```python
extensions = ["sphinx_disqus.disqus"]
disqus_shortname = "my-cool-project"
```
Also add this to any document you wish to have comments:
```rst
.. disqus::
```
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-disqus",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Robpol86",
"author_email": "robpol86@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/eb/2b/99f037d395dafe23a16d1d8165fbdaa4e5cd60bf65e8281aa69819fbab7e/sphinx_disqus-1.3.0.tar.gz",
"platform": null,
"description": "# sphinx-disqus\n\nEmbed [Disqus](https://disqus.com) comments in Sphinx documents/pages.\n\n* Python 3.9 through 3.12 supported on Linux, macOS, and Windows.\n\n\ud83d\udcd6 Full documentation: https://sphinx-disqus.readthedocs.io\n\n[![Github-CI][github-ci]][github-link]\n[![Coverage Status][codecov-badge]][codecov-link]\n[![Documentation Status][rtd-badge]][rtd-link]\n[![Code style: black][black-badge]][black-link]\n[![PyPI][pypi-badge]][pypi-link]\n[![PyPI Downloads][pypi-dl-badge]][pypi-dl-link]\n\n[github-ci]: https://github.com/Robpol86/sphinx-disqus/actions/workflows/ci.yml/badge.svg?branch=main\n[github-link]: https://github.com/Robpol86/sphinx-disqus/actions/workflows/ci.yml\n[codecov-badge]: https://codecov.io/gh/Robpol86/sphinx-disqus/branch/main/graph/badge.svg\n[codecov-link]: https://codecov.io/gh/Robpol86/sphinx-disqus\n[rtd-badge]: https://readthedocs.org/projects/sphinx-disqus/badge/?version=latest\n[rtd-link]: https://sphinx-disqus.readthedocs.io/en/latest/?badge=latest\n[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg\n[black-link]: https://github.com/ambv/black\n[pypi-badge]: https://img.shields.io/pypi/v/sphinx-disqus.svg\n[pypi-link]: https://pypi.org/project/sphinx-disqus\n[pypi-dl-badge]: https://img.shields.io/pypi/dw/sphinx-disqus?label=pypi%20downloads\n[pypi-dl-link]: https://pypistats.org/packages/sphinx-disqus\n\n## Quickstart\n\nTo install run the following:\n\n```bash\npip install sphinx-disqus\n```\n\nTo use in Sphinx simply add to your `conf.py`:\n\n```python\nextensions = [\"sphinx_disqus.disqus\"]\ndisqus_shortname = \"my-cool-project\"\n```\n\nAlso add this to any document you wish to have comments:\n\n```rst\n.. disqus::\n```\n\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Embed Disqus comments in Sphinx documents/pages.",
"version": "1.3.0",
"project_urls": {
"documentation": "https://sphinx-disqus.readthedocs.io",
"repository": "https://github.com/Robpol86/sphinx-disqus"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27568b16f28bb90829344d39e305e4795bbef1f6d03a0f5664c78ab3c7f67501",
"md5": "97e13c67e99d1bd3ee77079ad44d7504",
"sha256": "8608fc4b3148055c41a390dd250883ebee7f28c5bfac00997a3fbe1ec8985466"
},
"downloads": -1,
"filename": "sphinx_disqus-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "97e13c67e99d1bd3ee77079ad44d7504",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 6308,
"upload_time": "2024-07-07T17:49:27",
"upload_time_iso_8601": "2024-07-07T17:49:27.156490Z",
"url": "https://files.pythonhosted.org/packages/27/56/8b16f28bb90829344d39e305e4795bbef1f6d03a0f5664c78ab3c7f67501/sphinx_disqus-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb2b99f037d395dafe23a16d1d8165fbdaa4e5cd60bf65e8281aa69819fbab7e",
"md5": "b9372cd00be7010f21abaf04e0462d32",
"sha256": "80590a486c817acddcf0a1fbc07a750fd17694272c959364e4e3c0b43bb6d6d3"
},
"downloads": -1,
"filename": "sphinx_disqus-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "b9372cd00be7010f21abaf04e0462d32",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 5168,
"upload_time": "2024-07-07T17:49:28",
"upload_time_iso_8601": "2024-07-07T17:49:28.481833Z",
"url": "https://files.pythonhosted.org/packages/eb/2b/99f037d395dafe23a16d1d8165fbdaa4e5cd60bf65e8281aa69819fbab7e/sphinx_disqus-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-07 17:49:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Robpol86",
"github_project": "sphinx-disqus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-disqus"
}
