feat: add help menu

bioxelnodes/blender_manifest.toml

@@ -1,7 +1,7 @@
 schema_version = "1.0.0"
 
 id = "bioxelnodes"
-version = "1.0.3"
+version = "1.0.4"
 name = "Bioxel Nodes"
 tagline = "For scientific volumetric data visualization in Blender"
 maintainer = "Ma Nan <[email protected]>"

bioxelnodes/constants.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-VERSIONS = [{"label": "Latest", "node_version": (1, 0, 3)},
+VERSIONS = [{"label": "Latest", "node_version": (1, 0, 4)},
             {"label": "v0.3.x", "node_version": (0, 3, 3)},
             {"label": "v0.2.x", "node_version": (0, 2, 9)}]
 

bioxelnodes/menus.py

@@ -19,7 +19,7 @@
                                   ExtractNodeMesh, ExtractNodeBboxWire, ExtractNodeShapeWire)
 
 from .operators.io import (ImportAsLabel, ImportAsScalar, ImportAsColor)
-from .operators.misc import (CleanTemp,
+from .operators.misc import (CleanTemp, Help,
                              ReLinkNodeLib, RemoveAllMissingLayers,
                              RenderSettingPreset, SaveAllLayersCache,
                              SaveNodeLib, SliceViewer)
@@ -57,6 +57,10 @@ def draw(self, context):
         layout.separator()
         layout.menu(RenderSettingMenu.bl_idname)
 
+        layout.separator()
+        layout.operator(Help.bl_idname,
+                        icon=Help.bl_icon)
+
 
 class FetchLayerMenu(bpy.types.Menu):
     bl_idname = "BIOXELNODES_MT_ADD_LAYER"
@@ -210,6 +214,10 @@ def draw(self, context):
         layout.separator()
         layout.menu(RenderSettingMenu.bl_idname)
 
+        layout.separator()
+        layout.operator(Help.bl_idname,
+                        icon=Help.bl_icon)
+
 
 def TOPBAR(self, context):
     layout = self.layout

bioxelnodes/operators/misc.py

@@ -1,3 +1,4 @@
+import webbrowser
 import bpy
 from pathlib import Path
 import shutil
@@ -260,3 +261,16 @@ def invoke(self, context, event):
                                               event,
                                               message=f"Are you sure to remove all **Missing** layers?")
         return {'RUNNING_MODAL'}
+
+
+class Help(bpy.types.Operator):
+    bl_idname = "bioxelnodes.help"
+    bl_label = "Need Help?"
+    bl_description = "Online Manual for Beginner"
+    bl_icon = "HELP"
+
+    def execute(self, context):
+        webbrowser.open(
+            'https://omoolab.github.io/BioxelNodes/latest/', new=2)
+
+        return {'FINISHED'}

docs/qa.md → docs/faq.md

@@ -1,4 +1,4 @@
-# Q & A
+# FAQ
 
 ## Nothing in the scene when rendering?
 

mkdocs.yml

@@ -14,7 +14,7 @@ nav:
       - Advanced Usage: advanced_usage.md
       - Support Format: support_format.md
       - Improve Performance: improve_performance.md
-      - Q & A: qa.md
+      - FAQ: faq.md
   - Tutorials:
       - SARS-Cov-2: SARS-Cov-2.md
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "bioxelnodes"
-version = "1.0.3"
+version = "1.0.4"
 description = ""
 authors = ["Ma Nan <[email protected]>"]
 license = "MIT"