Giscus integration in sphinx/readthedocs documentation

[4flixt]

Hi,

thank you for developing giscus and sharing it with us. I would love to integrate the feature in the documentation of our project do-mpc.

This documentation is autogenerated with sphinx/readthedocs from our Github repository.
It is slightly tricky to include custom html content in sphinx but it works. I tried to include the code snippet generated by Giscus now in the rst file Discussion.rst:

**********
Discussion
**********

.. raw :: html

    <div class="giscus-container">
	<script src="https://giscus.app/client.js"
	        data-repo="do-mpc/do-mpc"
	        data-repo-id="MDEwOlJlcG9zaXRvcnkzNTk3NzI5MA=="
	        data-category="General"
	        data-category-id="MDE4OkRpc2N1c3Npb25DYXRlZ29yeTMyNzI5OTYz"
	        data-mapping="pathname"
	        data-reactions-enabled="1"
	        data-emit-metadata="0"
	        data-theme="light"
	        data-lang="en"
	        crossorigin="anonymous"
	        async>
	</script>
    </div>

This did build the following website on the develop version of the docs:

https://www.do-mpc.com/en/develop/Discussion.html

Unfortunately, I don't see any Giscus Plugin here. Inspecting the html document shows that the script was seemingly integrated as expected.

Is it possible to make this work? Thank you so much in advance :)

Best,
4flixt

[4flixt]

Note that I have currently tested:

data-mapping="number"
data-term="220"

pointing to this discussion: do-mpc/do-mpc#220.

[laymonage]

Thanks for the report!

Apparently it seems because some of the variables used in the client script is already defined in the scope. I'll try to fix it soon.

[4flixt]

Hi @laymonage ! Thank you for the swift reply and for identifying the problem. I'll wait for further updates then :)

[laymonage]

Should be working now :)

Thanks!

[4flixt]

wow, you are fast! Thanks a lot :)