Getting Started¶
Note
We assume you already have a Sphinx documentation, if not, see Getting Started with Sphinx.
First, downloading extension from PyPI (see Installation for more details):
$ pip install sphinxnotes-isso
Then, add the extension name to extensions
configuration item in your conf.py:
extensions = [
# …
'sphinxnotes.isso',
# …
]
Note
Before using the extension, you should have an Isso instance deployed.
Still in conf.py, set isso_url
Configuration item to the URL of your Isso instance.
isso_url = 'https://HOST:PORT'
Then use directive isso
to embed Isso comment box to your doccument:
.. isso::
Just like this:
Feel free to comment~