Add comments and annotation to your documentation.
Add comments and annotation functionality to your Sphinx website.
Currently, these commenting engines are supported:
dokie.li
is an open source commenting and annotation overlay built on web standards.For examples of each service, as well as instructions for how to activate it,
see the sphinx-comments
documentation.
Sphinx Comments follows the Executable Books contributing guide.
To install sphinx-comments
for development, take the following steps:
git clone https://github.com/executablebooks/sphinx-comments
cd sphinx-comments
pip install -e .[testing,sphinx]
This will install the dependencies needed for development and testing.
Sphinx Comments is a lightweight Sphinx extension that activates several Javascript libraries for use within Sphinx. All of its functionality is contained in sphinx_comments/__init__.py
.
As a general rule, Sphinx Comments tries to be as lightweight as possible. It simply:
Note that some of these platforms cannot be activated at the same time, users will need to choose one or the other.
Some of the annotation platforms require more complex setup - for example, utteranc.es
requires its script to be placed in a specific location on the page, and so sphinx-comments
will place it directly in the doctree of the page (underneath the content).