configurable toggle text

Author: choldgraf

docs/index.rst

@@ -162,3 +162,15 @@ Here's how they look right after one another:
     :class: toggle
 
     This is my second.
+
+
+Configuration
+=============
+
+You can control the "hint" text that is displayed next to togglebuttons when
+their content is collapsed. To do so, use the following configuration variable
+in your ``conf.py`` file:
+
+.. code-block:: python
+
+    togglebutton_hint = "My text"

setup.py

@@ -24,7 +24,7 @@
     license="MIT License",
     packages=find_packages(),
     package_data={
-        "sphinx_togglebutton": ["_static/togglebutton.css", "_static/togglebutton.js"]
+        "sphinx_togglebutton": ["_static/togglebutton.css_t", "_static/togglebutton.js"]
     },
     install_requires=["setuptools", "wheel", "sphinx", "docutils"],
     extras_require={"sphinx": ["myst_nb"]},

sphinx_togglebutton/__init__.py

@@ -11,6 +11,11 @@ def st_static_path(app):
     app.config.html_static_path.append(static_path)
 
 
+def add_to_context(app, config):
+    # Update the global context
+    config.html_context.update({'togglebutton_hint': config.togglebutton_hint})
+
+
 # This function reads in a variable and inserts it into JavaScript
 def insert_custom_selection_config(app):
     # This is a configuration that you've specified for users in `conf.py`
@@ -58,10 +63,12 @@ def setup(app):
     # Add the string we'll use to select items in the JS
     # Tell Sphinx about this configuration variable
     app.add_config_value("togglebutton_selector", ".toggle", "html")
+    app.add_config_value("togglebutton_hint", "Click to show", "html")
     app.add_js_file("togglebutton.js")
 
     # Run the function after the builder is initialized
     app.connect("builder-inited", insert_custom_selection_config)
+    app.connect("config-inited", add_to_context)
     app.add_directive("toggle", Toggle)
     return {
         "version": __version__,

sphinx_togglebutton/_static/togglebutton.css renamed to sphinx_togglebutton/_static/togglebutton.css_t

@@ -52,7 +52,7 @@ button.toggle-button {
 }
 
 button.toggle-button.toggle-button-hidden:before {
-    content: "Click to show";
+    content: "{{ togglebutton_hint }}";
     position: absolute;
     left: -6.5em;
     bottom: .4em;