{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Integrates third-party commenting and annotation services into Sphinx-generated documentation sites.","skillfed_tags":["sphinx-extension","abandoned"],"use_cases":["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."],"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\u2014Hypothes.is for collaborative web annotation, utteranc.es for GitHub-backed comments, or dokie.li for open-source annotation overlays\u2014without implementing commenting itself. The extension handles platform-specific requirements like script placement in the page structure.\n\nThe 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.","worth_installing":"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."},"id":"sphinx-comments","links":{"html":"https://skillfed.io/packages/sphinx-comments","md":"https://skillfed.io/packages/sphinx-comments.md","pypi":"https://pypi.org/project/sphinx-comments/"},"maintenance":{"status":"abandoned"},"meta":{"latest_release":"2020-08-12","license_spdx":null,"license_treatment":"permissive","name":"sphinx-comments","python_support":"unspecified","summary":"Add comments and annotation to your documentation."},"popularity":{"monthly_downloads":203218,"position":9634,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.0.3"}