search

executablebooks / sphinx-comments

hypothes.is interaction layer with Sphinx
https://sphinx-comments.readthedocs.io
MIT License
20 stars 8 forks source link

Incorrect installation instructions #15

Closed smithara closed 3 years ago

smithara commented 3 years ago

At https://sphinx-comments.readthedocs.io/en/latest/#installation

I found that:

html_extensions = [
   "sphinx_comments"
]

had no effect, but instead needed:

extensions = [
   "sphinx_comments"
]

(I am actually not aware of how extensions work! or what html_extensions refers to)

Anyway thanks for the great tool!

welcome[bot] commented 3 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

choldgraf commented 3 years ago

thanks for reporting! fixed in https://github.com/executablebooks/sphinx-comments/pull/16 ✨