Update guides

docs/source/development/guides.rst

@@ -49,3 +49,23 @@ Developers have two options when using the ``InAppGuide`` widget:
 A decent amount of ``InAppGuide(identifier=<identifier>)`` instances have been placed strategically throughout the app.
 Developers may suggest additional core guide sections via GitHub pull requests.
 For plugin developers, additional instances of either flavor are recommended to be added in any component of the plugin in conjunction with dedicated plugin-specific guides.
+
+Plugin guides
+-------------
+
+Plugin developers may introduce additional guides to the app. To do so, add the following key/value entry in your plugin's ``__init__.py`` file:
+
+.. code:: python
+
+    my_plugin = {
+        ...
+        "guides": <path-to-guide>,
+    }
+
+where ``path-to-guide`` is the path (``Path`` object or absolute string path) to the directory containing the guide HTML files.
+On app start, the guide manager will scan the plugin entry points for the ``guides`` key and load the guides accordingly.
+
+Guide order
+-----------
+
+When naming your guide HTML documents, prefix the file name with ``#_``. The number ``#`` will determine the order in which the guides are displayed in the list.

src/aiidalab_qe/common/guide_manager.py

@@ -86,11 +86,12 @@ def _on_active_guide_change(self, _):
 
     def _fetch_plugin_guides(self):
         """Fetch guides from plugins."""
-        entries: dict[str, Path] = get_entry_items("aiidalab_qe.properties", "guides")
+        entries: dict = get_entry_items("aiidalab_qe.properties", "guides")
         for identifier, guides in entries.items():
+            path = Path(guides)
             if identifier not in self._guides:
                 self._guides[identifier] = {}
-            for guide in sorted(guides.glob("*"), key=lambda x: x.stem.split("_")[0]):
+            for guide in sorted(path.glob("*"), key=lambda x: x.stem.split("_")[0]):
                 stem = guide.stem.split("_", maxsplit=1)[1]
                 self._guides[identifier][stem] = guide.absolute()
 

src/aiidalab_qe/plugins/bands/__init__.py

@@ -1,6 +1,3 @@
-# from aiidalab_qe.bands.result import Result
-from pathlib import Path
-
 from aiidalab_qe.common.panel import PluginOutline
 
 from .model import BandsConfigurationSettingsModel
@@ -24,5 +21,4 @@ class BandsPluginOutline(PluginOutline):
         "model": BandsResourceSettingsModel,
     },
     "workchain": workchain_and_builder,
-    "guides": Path(__file__).parent / "guides",
 }

tests/test_infobox.py

@@ -35,13 +35,8 @@ def test_in_app_guide():
     assert in_app_guide.layout.display == "none"
     guide_manager.active_guide = "general/basic"
     assert in_app_guide.layout.display == "flex"
-    guide_manager.active_guide = "general/advanced"
-    assert in_app_guide.layout.display == "flex"
-    in_app_guide.guide_id = "general/advanced"
-    guide_manager.active_guide = "general/basic"
+    guide_manager.active_guide = "none"
     assert in_app_guide.layout.display == "none"
-    guide_manager.active_guide = "general/advanced"
-    assert in_app_guide.layout.display == "flex"
 
     guide_manager.active_guide = "general/basic"
     in_app_guide = InAppGuide(identifier="guide-warning")