sphinxnotes-isso¶

Sphinx extension for embeding Isso comments in documents.

Introduction¶

The extension allows your embedding Isso comments in your Sphinx documentation:

Note

We assume you already have a Sphinx documentation, if not, see Getting Started with Sphinx.

First, downloading extension from PyPI:

$ pip install sphinxnotes-isso

Then, add the extension name to extensions configuration item in your conf.py:

extensions = [
          # …
          'sphinxnotes.isso',
          # …
          ]

Set ⚙️isso_url to the URL of your Isso server.

isso_url = 'https://HOST:PORT'

And then you can use directive isso to insert a Isso comment box, see Usage for more details.

Result

reStructuredText

.. isso::

Feel free to comment~

Contents

The project is developed by Shengyu Zhang, as part of The Sphinx Notes Project.

The Sphinx Notes Project