{"library":"sphinx-comments","title":"Sphinx Comments","type":"library","description":"Sphinx Comments is a lightweight Sphinx extension that adds comments and annotation functionality to your Sphinx documentation websites. It currently supports integration with popular commenting engines such as Hypothes.is, utteranc.es, and dokie.li. The library is currently at version 0.0.3, with an irregular release cadence that primarily reflects updates to supported commenting platforms or minor Sphinx compatibility adjustments.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install sphinx-comments"],"cli":null},"imports":["extensions = ['sphinx_comments']"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/executablebooks/sphinx-comments","docs":null,"changelog":null,"pypi":"https://pypi.org/project/sphinx-comments/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"import os\nimport sys\n\n# conf.py\n\n# Basic project information\nproject = 'My Commented Docs'\ncopyright = '2026, My Organization'\nauthor = 'Doc Creator'\n\n# Add 'sphinx_comments' to your extensions list\nextensions = [\n    'sphinx.ext.autodoc', # A commonly used Sphinx extension\n    'sphinx_comments',\n]\n\n# Configure the commenting engine. Choose one and provide its configuration.\n# Example 1: Activate Hypothes.is\ncomments_config = {\n   \"hypothesis\": True\n}\n\n# Example 2: Activate utteranc.es (requires a GitHub repository for issues)\n# comments_config = {\n#    \"utterances\": {\n#        \"repo\": \"your-github-org/your-github-repo\", # REQUIRED: Replace with your repo\n#        \"issue-term\": \"pathname\", # or 'url', 'title', 'og:title'\n#        \"theme\": \"github-light\", # or 'github-dark', 'preferred-color-scheme', etc.\n#        \"label\": \"discussion\", # Optional: label for new issues\n#    }\n# }\n\n# Example 3: Activate dokie.li (experimental)\n# comments_config = {\n#    \"dokieli\": True\n# }\n\n# Set your desired HTML theme\nhtml_theme = 'alabaster'\n","lang":"python","description":"To quickly integrate sphinx-comments, first install it via pip. Then, modify your Sphinx project's `conf.py` file to include 'sphinx_comments' in the `extensions` list. Finally, define a `comments_config` dictionary, choosing and configuring your desired commenting engine (e.g., Hypothes.is or utteranc.es) according to the library's documentation. Ensure to replace placeholder values like 'your-github-org/your-github-repo' if using utteranc.es.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}