docs: enable gitter chat directly in docs

nejch · JohnVillalovos · commit bd1ecdd5ad65 · 2022-02-19T14:29:00.000-08:00
diff --git a/README.rst b/README.rst
@@ -98,8 +98,14 @@ https://github.com/python-gitlab/python-gitlab/issues.
 Gitter Community Chat
 ---------------------
 
-There is a `gitter <https://gitter.im/python-gitlab/Lobby>`_ community chat
-available at https://gitter.im/python-gitlab/Lobby
+We have a `gitter <https://gitter.im/python-gitlab/Lobby>`_ community chat
+available at https://gitter.im/python-gitlab/Lobby, which you can also
+directly access via the Open Chat button below.
+
+If you have a simple question, the community might be able to help already,
+without you opening an issue. If you regularly use python-gitlab, we also
+encourage you to join and participate. You might discover new ideas and
+use cases yourself!
 
 Documentation
 -------------
diff --git a/docs/_static/js/gitter.js b/docs/_static/js/gitter.js
@@ -0,0 +1,3 @@
+((window.gitter = {}).chat = {}).options = {
+  room: 'python-gitlab/Lobby'
+};
diff --git a/docs/conf.py b/docs/conf.py
@@ -145,7 +145,15 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ["_static"]
+
+html_js_files = [
+    "js/gitter.js",
+    (
+        "https://sidecar.gitter.im/dist/sidecar.v1.js",
+        {"async": "async", "defer": "defer"},
+    ),
+]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+((window.gitter = {}).chat = {}).options = {`
	`2`	`+ room: 'python-gitlab/Lobby'`
	`3`	`+};`