Refactor sphinx_togglebutton/__init__.py for readability

Improved code formatting and structure for better readability and maintainability. Added blank lines for separation, split long function calls, and enhanced consistency in function definitions and configuration setup.

Author: douden

sphinx_togglebutton/__init__.py

@@ -1,9 +1,11 @@
 """A small sphinx extension to add "toggle" buttons to items."""
+
 import os
 from docutils.parsers.rst import Directive, directives
 from docutils import nodes
 
 from sphinx.locale import get_translation
+
 MESSAGE_CATALOG_NAME = "togglebutton"
 translate = get_translation(MESSAGE_CATALOG_NAME)
 
@@ -17,16 +19,22 @@ def st_static_path(app):
 
 def initialize_js_assets(app, config):
     # Update the global context
+
     app.add_js_file(None, body=f"let toggleHintShow = '{config.togglebutton_hint}';")
-    app.add_js_file(None, body=f"let toggleHintHide = '{config.togglebutton_hint_hide}';")
+    app.add_js_file(
+        None, body=f"let toggleHintHide = '{config.togglebutton_hint_hide}';"
+    )
     open_print = str(config.togglebutton_open_on_print).lower()
     app.add_js_file(None, body=f"let toggleOpenOnPrint = '{open_print}';")
     app.add_js_file("togglebutton.js")
 
 
 # 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`
+
     selector = app.config["togglebutton_selector"]
     js_text = "var togglebuttonSelector = '%s';" % selector
     app.add_js_file(None, body=js_text)
@@ -46,34 +54,43 @@ def run(self):
         classes = ["toggle"]
         if "show" in self.options:
             classes.append("toggle-shown")
-
         parent = nodes.container(classes=classes)
         self.state.nested_parse(self.content, self.content_offset, parent)
         return [parent]
 
 
 # We connect this function to the step after the builder is initialized
+
+
 def setup(app):
     # add translations
+
     package_dir = os.path.abspath(os.path.dirname(__file__))
     locale_dir = os.path.join(package_dir, "translations", "locales")
     app.add_message_catalog(MESSAGE_CATALOG_NAME, locale_dir)
 
-
     # Add our static path
+
     app.connect("builder-inited", st_static_path)
 
     # Add relevant code to headers
+
     app.add_css_file("togglebutton.css")
 
     # 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, .admonition.dropdown", "html")
+
+    app.add_config_value(
+        "togglebutton_selector", ".toggle, .admonition.dropdown", "html"
+    )
     app.add_config_value("togglebutton_hint", f"{translate('Click to show')}", "html")
-    app.add_config_value("togglebutton_hint_hide", f"{translate('Click to hide')}", "html")
+    app.add_config_value(
+        "togglebutton_hint_hide", f"{translate('Click to hide')}", "html"
+    )
     app.add_config_value("togglebutton_open_on_print", True, "html")
 
     # Run the function after the builder is initialized
+
     app.connect("builder-inited", insert_custom_selection_config)
     app.connect("config-inited", initialize_js_assets)
     app.add_directive("toggle", Toggle)