sphinxnotes-isso

Sphinx extension for embeding Isso comments in documents

https://img.shields.io/github/stars/sphinx-notes/isso.svg?style=social&label=Star&maxAge=2592000
version

1.0

copyright

Copyright ©2021 by Shengyu Zhang.

license

BSD, see LICENSE for details.

Installation

Download it from official Python Package Index:

$ pip install sphinxnotes-isso

Add extension to conf.py in your sphinx project:

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

Configuration

isso_url

HTTP URL points to your Isso server

The following configuration items are corresponding to Isso Client Configuration , please use Python’s boolean, numeric value instead of string formatted value.

  • isso_css

  • isso_lang

  • isso_reply_to_self

  • isso_require_author

  • isso_require_email

  • isso_max_comments_top

  • isso_max_comments_nested

  • isso_reveal_on_click

  • isso_avatar

  • isso_avatar_bg

  • isso_avatar_fg

  • isso_vote

  • isso_vote_levels

  • isso_feed

Functionalities

The isso directive is used to insert a isso comment box. The docname of current document is used as Isso thread ID.

The directive supports the following options:

id

(text) Specify a thread ID rather than use docname

title

(text) Specify a thread title rather than use document title

The comment box at the bottom is generated via the following source:

.. isso::

Change Log

2021-04-21 1.0

Section author: Shengyu Zhang

  • Use document title as Isso thread title

2021-03-23 1.0a2

Section author: Shengyu Zhang

  • Fixes: Thread ID should starts with slash

2021-03-13 1.0a1

Section author: Shengyu Zhang

The first version is out, enjoy~