DOC: Add slicer.parameterNodeWrapper autodocs

Base/Python/slicer/parameterNodeWrapper/__init__.py

@@ -2,9 +2,14 @@
 access.
 """
 
+import os
+import sys
+_standalone_python = "python" in str.lower(os.path.split(sys.executable)[-1])
+
 from .default import *
-from .guiConnectors import *
-from .guiCreation import *
+if not _standalone_python:
+    from .guiConnectors import *
+    from .guiCreation import *
 from .parameterPack import *
 from .serializers import *
 from .types import *
@@ -17,3 +22,5 @@
     unannotatedType,
 )
 from .wrapper import *
+
+del _standalone_python

Base/Python/slicer/parameterNodeWrapper/wrapper.py

@@ -1,22 +1,30 @@
 """The wrapper module is responsible for creating parameterNodeWrappers"""
 
 import logging
+import os
+import sys
 import typing
 from typing import Optional
 import weakref
 
-import qt
+_standalone_python = "python" in str.lower(os.path.split(sys.executable)[-1])
+
+if not _standalone_python:
+    import qt
 
 import slicer
 import vtk
 
 from .default import Default, extractDefault
-from .guiConnectors import GuiConnector, createGuiConnector, _getPackNameToWidgetMap
+if not _standalone_python:
+    from .guiConnectors import GuiConnector, createGuiConnector, _getPackNameToWidgetMap
 from .parameterInfo import ParameterInfo
 from .parameterPack import _checkMember as checkPackMember
 from .serializers import Serializer, createSerializer
 from .util import splitAnnotations, splitPossiblyDottedName, unannotatedType
 
+del _standalone_python
+
 __all__ = [
     "parameterNodeWrapper",
     "SlicerParameterNamePropertyName",

Docs/Makefile

@@ -3,7 +3,8 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
+#SPHINXBUILD   = sphinx-build
+SPHINXBUILD   = PythonSlicer -m sphinx
 SPHINXPROJ    = 3DSlicer
 SOURCEDIR     = .
 BUILDDIR      = _build

Docs/conf.py

@@ -16,12 +16,16 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
+import importlib
 import lxml.etree as ET
 import os
 import sys
 from datetime import date
 
-sys.path.insert(0, os.path.abspath("../Base/Python"))
+try:
+    import slicer.kits
+except ImportError:
+    sys.path.insert(0, os.path.abspath("../Base/Python"))
 
 
 # -- General configuration ------------------------------------------------
@@ -48,10 +52,13 @@
 ]
 
 autodoc_mock_imports = [
-    "ctk",
-    "qt",
-    "vtk",
 ]
+for module in ["ctk", "qt", "vtk"]:
+    try:
+        importlib.import_module(module)
+    except ImportError:
+        print("[conf] Failed to import %s. Appending to autodoc_mock_imports" % module)
+        autodoc_mock_imports.append(module)
 
 myst_enable_extensions = [
     "attrs_inline",  # Enable parsing of inline attributes (see https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#inline-attributes)

Docs/developer_guide/api.md

@@ -18,10 +18,13 @@ Python-style documentation is available for the following packages:
 ```{toctree}
 :maxdepth: 2
 
-mrml
 slicer
+```
+
+```{toctree}
+:maxdepth: 1
+
 vtkTeem
-vtkAddon
 vtkITK
 ```
 

Docs/developer_guide/slicer.md

@@ -63,3 +63,13 @@
     :undoc-members:
     :show-inheritance:
 ```
+
+## slicer.parameterNodeWrapper
+
+```{eval-rst}
+.. automodule:: slicer.parameterNodeWrapper
+    :members:
+    :undoc-members:
+    :imported-members:
+    :show-inheritance:
+```