sphinxnotes-isso

Introduction

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

Note

Before using this extension, you should already have an Isso server deployed (How to deploy a Isso server?) and an accessible URL.

Getting Started

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 (How to deploy a Isso server?):

isso_url = 'https://HOST:PORT'

There are two ways to add a comment thread to documentation:

1. Use the ⚙️isso_include_patterns configuration item. For exampele:

   # Enable commenting for all documents
   isso_include_patterns = ['**']
   

2. Use the isso directive, this will only affect the current document.

   Result

   reStructuredText

   .. isso::
   

See Usage for more details.

Feel free to comment~

Contents

Contents

• Usage
  • Manual insert (at a specific location)
    • .. isso::
      • :title:
  • Batch insert (at the end of the document)
    • DocInfos
• Configuration
• Change Log
  • Version 2.x
  • Version 1.x

The Sphinx Notes Project

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

The Sphinx Notes Project

• Home
• Blog
• PyPI