sphinx-comments
Add comments and annotation to your documentation.
Decision gist · record as of 2026-08-14
No. The project is abandoned (last release 2020-08-12, last commit 2023-05-03) with no active maintenance. While the MIT license is permissive and install friction is low, you cannot rely on compatibility with current Sphinx versions or assurance that embedded third-party services remain functional. For new projects, evaluate maintained alternatives or integrate commenting services directly.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx as a runtime dependency; compatibility with current Sphinx versions is unverified given the project's abandonment.
- Low install friction—pure Python wheel with only Sphinx as a runtime dependency.
- However, the project is abandoned: last release was 2020-08-12 and last commit 2023-05-03, with no active maintenance.
License · maintenance · safety
MIT License (permissive) — MIT License (permissive) imposes no significant restrictions on use or redistribution.
last release 2020-08-12 (2193 days) · last repo commit 2023-05-03 · 26 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 203,218 downloads/mo, #9,634 on PyPI
Alternatives
Verify before relying
pip install sphinx-comments
In conf.py:
extensions = ['sphinx_comments']
Configure one of: hypothes.is, utteranc.es, or dokie.li per the documentation.- Compatibility with recent Sphinx versions (last release predates current Sphinx ecosystem by years).
- Whether the embedded JavaScript libraries (Hypothes.is, utteranc.es, dokie.li) remain functional and maintained.
- Support for modern Python versions and whether Python version constraints exist.
What it is and what it does
Sphinx Comments is a lightweight Sphinx extension that embeds JavaScript-based commenting and annotation platforms into your documentation. It acts as a configuration layer that loads and activates third-party services—Hypothes.is for collaborative web annotation, utteranc.es for GitHub-backed comments, or dokie.li for open-source annotation overlays—without implementing commenting itself. The extension handles platform-specific requirements like script placement in the page structure.
The package is designed to be minimal: it loads JavaScript libraries and provides configuration options for the platforms you choose. Most platforms cannot be activated simultaneously, so you select one per site. Setup complexity varies by platform; utteranc.es, for example, requires specific script placement that the extension manages automatically.
Use it for
- Enable reader annotations and highlights on published Sphinx documentation using Hypothes.is.
- Add GitHub-backed issue-based comments to your docs via utteranc.es integration.
- Activate open-source annotation overlays on documentation pages using dokie.li.
- Allow collaborative discussion and feedback on technical documentation without building a custom backend.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
No.
The project is abandoned (last release 2020-08-12, last commit 2023-05-03) with no active maintenance. While the MIT license is permissive and install friction is low, you cannot rely on compatibility with current Sphinx versions or assurance that embedded third-party services remain functional. For new projects, evaluate maintained alternatives or integrate commenting services directly.
Install
sphinx-comments on PyPI
Before you install
Low install friction—pure Python wheel with only Sphinx as a runtime dependency. However, the project is abandoned: last release was 2020-08-12 and last commit 2023-05-03, with no active maintenance.
Requires Sphinx as a runtime dependency; compatibility with current Sphinx versions is unverified given the project's abandonment.
License in practice
MIT License (permissive) imposes no significant restrictions on use or redistribution.
Quickstart
pip install sphinx-comments
In conf.py:
extensions = ['sphinx_comments']
Configure one of: hypothes.is, utteranc.es, or dokie.li per the documentation.Verify before relying
- Compatibility with recent Sphinx versions (last release predates current Sphinx ecosystem by years).
- Whether the embedded JavaScript libraries (Hypothes.is, utteranc.es, dokie.li) remain functional and maintained.
- Support for modern Python versions and whether Python version constraints exist.
Package facts
| License | MIT License permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagesphinx |
| Maintenance | Abandoned 2,193 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 203,218 / month, #9,634 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | License :: OSI Approved :: MIT License |
Evidence: sphinx_comments-0.0.3-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx comments annotation”
- sphinx-commentsIntegrates third-party commenting and annotation services into…
- code-annotationsParses and summarizes code annotations (originally for PII detection)…
- linuxdocSphinx-doc extensions and command-line tools that extract…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also sphinxcontrib-googleanalytics · sphinxcontrib-websupport · sphinxcontrib-mermaid · swagger-plugin-for-sphinx · linuxdoc · sphinxcontrib-autoyaml · sphinx-autodoc-typehints · recommonmark · sphinx-inline-tabs · readthedocs-sphinx-search