Merge pull request #7 from Matter-and-Form/feature/documentation

Feature/documentation
Matter-and-Form · Nov 27, 2024 · 25a3cd9 · 25a3cd9
2 parents e717769 + 6634205
commit 25a3cd9
Show file tree

Hide file tree

Showing 314 changed files with 97,356 additions and 10,165 deletions.
diff --git a/.github/workflows/CD.yml b/.github/workflows/CD.yml
@@ -36,6 +36,10 @@ jobs:
 
     - name: Build the package
       run: python -m build
+
+    - name: Build Documentation
+      run: |
+        python3 ./scripts/build_doc.py
 
     - name: Publish to PyPI
       env:

diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -41,6 +41,10 @@ jobs:
     - name: Build the package
       run: python -m build
 
+    - name: Build Documentation
+      run: |
+        python3 ./scripts/build_doc.py
+
     - name: Publish to TestPyPI
       env:
         TWINE_USERNAME: __token__

diff --git a/three/Makefile → Makefile b/three/Makefile → Makefile
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./three.html"/>
+</head>
+</html>
diff --git a/docs/search.js b/docs/search.js
diff --git a/docs/three.html b/docs/three.html
diff --git a/docs/three/MF.html b/docs/three/MF.html
diff --git a/docs/three/MF/V3.html b/docs/three/MF/V3.html
diff --git a/docs/three/MF/V3/Buffer.html b/docs/three/MF/V3/Buffer.html
diff --git a/docs/three/MF/V3/Descriptors.html b/docs/three/MF/V3/Descriptors.html
diff --git a/docs/three/MF/V3/Descriptors/BoundingBox.html b/docs/three/MF/V3/Descriptors/BoundingBox.html
diff --git a/docs/three/MF/V3/Descriptors/Calibration.html b/docs/three/MF/V3/Descriptors/Calibration.html
diff --git a/docs/three/MF/V3/Descriptors/Export.html b/docs/three/MF/V3/Descriptors/Export.html
diff --git a/docs/three/MF/V3/Descriptors/Image.html b/docs/three/MF/V3/Descriptors/Image.html
diff --git a/docs/three/MF/V3/Descriptors/Merge.html b/docs/three/MF/V3/Descriptors/Merge.html
diff --git a/docs/three/MF/V3/Descriptors/Network.html b/docs/three/MF/V3/Descriptors/Network.html
diff --git a/docs/three/MF/V3/Descriptors/Project.html b/docs/three/MF/V3/Descriptors/Project.html
diff --git a/docs/three/MF/V3/Descriptors/ProjectActions.html b/docs/three/MF/V3/Descriptors/ProjectActions.html
diff --git a/docs/three/MF/V3/Descriptors/RemoveVertices.html b/docs/three/MF/V3/Descriptors/RemoveVertices.html
diff --git a/docs/three/MF/V3/Descriptors/ScanData.html b/docs/three/MF/V3/Descriptors/ScanData.html
diff --git a/docs/three/MF/V3/Descriptors/Settings.html b/docs/three/MF/V3/Descriptors/Settings.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/Advanced.html b/docs/three/MF/V3/Descriptors/Settings/Advanced.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/Camera.html b/docs/three/MF/V3/Descriptors/Settings/Camera.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/Capture.html b/docs/three/MF/V3/Descriptors/Settings/Capture.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/I18n.html b/docs/three/MF/V3/Descriptors/Settings/I18n.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/Projector.html b/docs/three/MF/V3/Descriptors/Settings/Projector.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/Scanner.html b/docs/three/MF/V3/Descriptors/Settings/Scanner.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/Software.html b/docs/three/MF/V3/Descriptors/Settings/Software.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/Style.html b/docs/three/MF/V3/Descriptors/Settings/Style.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/Turntable.html b/docs/three/MF/V3/Descriptors/Settings/Turntable.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/Tutorials.html b/docs/three/MF/V3/Descriptors/Settings/Tutorials.html
diff --git a/docs/three/MF/V3/Descriptors/Settings/Viewer.html b/docs/three/MF/V3/Descriptors/Settings/Viewer.html
diff --git a/docs/three/MF/V3/Descriptors/Software.html b/docs/three/MF/V3/Descriptors/Software.html
diff --git a/docs/three/MF/V3/Descriptors/System.html b/docs/three/MF/V3/Descriptors/System.html
diff --git a/docs/three/MF/V3/Descriptors/Transform.html b/docs/three/MF/V3/Descriptors/Transform.html
diff --git a/docs/three/MF/V3/Descriptors/VideoFrame.html b/docs/three/MF/V3/Descriptors/VideoFrame.html
diff --git a/docs/three/MF/V3/Descriptors/Wifi.html b/docs/three/MF/V3/Descriptors/Wifi.html
diff --git a/docs/three/MF/V3/Settings.html b/docs/three/MF/V3/Settings.html
diff --git a/docs/three/MF/V3/Settings/Advanced.html b/docs/three/MF/V3/Settings/Advanced.html
diff --git a/docs/three/MF/V3/Settings/Align.html b/docs/three/MF/V3/Settings/Align.html
diff --git a/docs/three/MF/V3/Settings/AutoFocus.html b/docs/three/MF/V3/Settings/AutoFocus.html
diff --git a/docs/three/MF/V3/Settings/BoundingBox.html b/docs/three/MF/V3/Settings/BoundingBox.html
diff --git a/docs/three/MF/V3/Settings/Camera.html b/docs/three/MF/V3/Settings/Camera.html
diff --git a/docs/three/MF/V3/Settings/Capture.html b/docs/three/MF/V3/Settings/Capture.html
diff --git a/docs/three/MF/V3/Settings/CopyGroup.html b/docs/three/MF/V3/Settings/CopyGroup.html
diff --git a/docs/three/MF/V3/Settings/CopyProject.html b/docs/three/MF/V3/Settings/CopyProject.html
diff --git a/docs/three/MF/V3/Settings/Export.html b/docs/three/MF/V3/Settings/Export.html
diff --git a/docs/three/MF/V3/Settings/Group.html b/docs/three/MF/V3/Settings/Group.html
diff --git a/docs/three/MF/V3/Settings/I18n.html b/docs/three/MF/V3/Settings/I18n.html
diff --git a/docs/three/MF/V3/Settings/Merge.html b/docs/three/MF/V3/Settings/Merge.html
diff --git a/docs/three/MF/V3/Settings/NewGroup.html b/docs/three/MF/V3/Settings/NewGroup.html
diff --git a/docs/three/MF/V3/Settings/Project.html b/docs/three/MF/V3/Settings/Project.html
diff --git a/docs/three/MF/V3/Settings/Projector.html b/docs/three/MF/V3/Settings/Projector.html
diff --git a/docs/three/MF/V3/Settings/Quality.html b/docs/three/MF/V3/Settings/Quality.html
diff --git a/docs/three/MF/V3/Settings/Rectangle.html b/docs/three/MF/V3/Settings/Rectangle.html
diff --git a/docs/three/MF/V3/Settings/Remesh.html b/docs/three/MF/V3/Settings/Remesh.html
diff --git a/docs/three/MF/V3/Settings/RemoveVertices.html b/docs/three/MF/V3/Settings/RemoveVertices.html
diff --git a/docs/three/MF/V3/Settings/Scan.html b/docs/three/MF/V3/Settings/Scan.html
diff --git a/docs/three/MF/V3/Settings/ScanData.html b/docs/three/MF/V3/Settings/ScanData.html
diff --git a/docs/three/MF/V3/Settings/ScanSelection.html b/docs/three/MF/V3/Settings/ScanSelection.html
diff --git a/docs/three/MF/V3/Settings/Scanner.html b/docs/three/MF/V3/Settings/Scanner.html
diff --git a/docs/three/MF/V3/Settings/Software.html b/docs/three/MF/V3/Settings/Software.html
diff --git a/docs/three/MF/V3/Settings/Style.html b/docs/three/MF/V3/Settings/Style.html
diff --git a/docs/three/MF/V3/Settings/Turntable.html b/docs/three/MF/V3/Settings/Turntable.html
diff --git a/docs/three/MF/V3/Settings/Tutorials.html b/docs/three/MF/V3/Settings/Tutorials.html
diff --git a/docs/three/MF/V3/Settings/Video.html b/docs/three/MF/V3/Settings/Video.html
diff --git a/docs/three/MF/V3/Settings/Viewer.html b/docs/three/MF/V3/Settings/Viewer.html
diff --git a/docs/three/MF/V3/Settings/Wifi.html b/docs/three/MF/V3/Settings/Wifi.html
diff --git a/docs/three/MF/V3/Task.html b/docs/three/MF/V3/Task.html
diff --git a/docs/three/MF/V3/Tasks.html b/docs/three/MF/V3/Tasks.html
diff --git a/docs/three/MF/V3/Tasks/AddMergeToProject.html b/docs/three/MF/V3/Tasks/AddMergeToProject.html
diff --git a/docs/three/MF/V3/Tasks/Align.html b/docs/three/MF/V3/Tasks/Align.html
diff --git a/docs/three/MF/V3/Tasks/AutoFocus.html b/docs/three/MF/V3/Tasks/AutoFocus.html
diff --git a/docs/three/MF/V3/Tasks/BoundingBox.html b/docs/three/MF/V3/Tasks/BoundingBox.html
diff --git a/docs/three/MF/V3/Tasks/CalibrateCameras.html b/docs/three/MF/V3/Tasks/CalibrateCameras.html
diff --git a/docs/three/MF/V3/Tasks/CalibrateTurntable.html b/docs/three/MF/V3/Tasks/CalibrateTurntable.html
diff --git a/docs/three/MF/V3/Tasks/CalibrationCaptureTargets.html b/docs/three/MF/V3/Tasks/CalibrationCaptureTargets.html
diff --git a/docs/three/MF/V3/Tasks/CameraCalibration.html b/docs/three/MF/V3/Tasks/CameraCalibration.html
diff --git a/docs/three/MF/V3/Tasks/CloseProject.html b/docs/three/MF/V3/Tasks/CloseProject.html
diff --git a/docs/three/MF/V3/Tasks/ConnectWifi.html b/docs/three/MF/V3/Tasks/ConnectWifi.html
diff --git a/docs/three/MF/V3/Tasks/DepthMap.html b/docs/three/MF/V3/Tasks/DepthMap.html
diff --git a/docs/three/MF/V3/Tasks/DetectCalibrationCard.html b/docs/three/MF/V3/Tasks/DetectCalibrationCard.html
diff --git a/docs/three/MF/V3/Tasks/DownloadProject.html b/docs/three/MF/V3/Tasks/DownloadProject.html
diff --git a/docs/three/MF/V3/Tasks/Export.html b/docs/three/MF/V3/Tasks/Export.html
diff --git a/docs/three/MF/V3/Tasks/ExportLogs.html b/docs/three/MF/V3/Tasks/ExportLogs.html
diff --git a/docs/three/MF/V3/Tasks/ExportMerge.html b/docs/three/MF/V3/Tasks/ExportMerge.html
diff --git a/docs/three/MF/V3/Tasks/FlattenGroup.html b/docs/three/MF/V3/Tasks/FlattenGroup.html
diff --git a/docs/three/MF/V3/Tasks/ForgetWifi.html b/docs/three/MF/V3/Tasks/ForgetWifi.html
diff --git a/docs/three/MF/V3/Tasks/HasCameras.html b/docs/three/MF/V3/Tasks/HasCameras.html
diff --git a/docs/three/MF/V3/Tasks/HasProjector.html b/docs/three/MF/V3/Tasks/HasProjector.html
diff --git a/docs/three/MF/V3/Tasks/HasTurntable.html b/docs/three/MF/V3/Tasks/HasTurntable.html
diff --git a/docs/three/MF/V3/Tasks/ListExportFormats.html b/docs/three/MF/V3/Tasks/ListExportFormats.html
diff --git a/docs/three/MF/V3/Tasks/ListGroups.html b/docs/three/MF/V3/Tasks/ListGroups.html
diff --git a/docs/three/MF/V3/Tasks/ListNetworkInterfaces.html b/docs/three/MF/V3/Tasks/ListNetworkInterfaces.html
diff --git a/docs/three/MF/V3/Tasks/ListProjects.html b/docs/three/MF/V3/Tasks/ListProjects.html
diff --git a/docs/three/MF/V3/Tasks/ListScans.html b/docs/three/MF/V3/Tasks/ListScans.html
diff --git a/docs/three/MF/V3/Tasks/ListSettings.html b/docs/three/MF/V3/Tasks/ListSettings.html
diff --git a/docs/three/MF/V3/Tasks/ListWifi.html b/docs/three/MF/V3/Tasks/ListWifi.html
diff --git a/docs/three/MF/V3/Tasks/Merge.html b/docs/three/MF/V3/Tasks/Merge.html
diff --git a/docs/three/MF/V3/Tasks/MergeData.html b/docs/three/MF/V3/Tasks/MergeData.html
diff --git a/docs/three/MF/V3/Tasks/MoveGroup.html b/docs/three/MF/V3/Tasks/MoveGroup.html
diff --git a/docs/three/MF/V3/Tasks/NewGroup.html b/docs/three/MF/V3/Tasks/NewGroup.html
diff --git a/docs/three/MF/V3/Tasks/NewProject.html b/docs/three/MF/V3/Tasks/NewProject.html
diff --git a/docs/three/MF/V3/Tasks/NewScan.html b/docs/three/MF/V3/Tasks/NewScan.html
diff --git a/docs/three/MF/V3/Tasks/OpenProject.html b/docs/three/MF/V3/Tasks/OpenProject.html
diff --git a/docs/three/MF/V3/Tasks/PopSettings.html b/docs/three/MF/V3/Tasks/PopSettings.html
diff --git a/docs/three/MF/V3/Tasks/PushSettings.html b/docs/three/MF/V3/Tasks/PushSettings.html
diff --git a/docs/three/MF/V3/Tasks/Reboot.html b/docs/three/MF/V3/Tasks/Reboot.html
diff --git a/docs/three/MF/V3/Tasks/RemoveGroups.html b/docs/three/MF/V3/Tasks/RemoveGroups.html
diff --git a/docs/three/MF/V3/Tasks/RemoveProjects.html b/docs/three/MF/V3/Tasks/RemoveProjects.html
diff --git a/docs/three/MF/V3/Tasks/RestoreFactoryCalibration.html b/docs/three/MF/V3/Tasks/RestoreFactoryCalibration.html
diff --git a/docs/three/MF/V3/Tasks/RotateTurntable.html b/docs/three/MF/V3/Tasks/RotateTurntable.html
diff --git a/docs/three/MF/V3/Tasks/ScanData.html b/docs/three/MF/V3/Tasks/ScanData.html
diff --git a/docs/three/MF/V3/Tasks/SetCameras.html b/docs/three/MF/V3/Tasks/SetCameras.html
diff --git a/docs/three/MF/V3/Tasks/SetGroup.html b/docs/three/MF/V3/Tasks/SetGroup.html
diff --git a/docs/three/MF/V3/Tasks/SetProject.html b/docs/three/MF/V3/Tasks/SetProject.html
diff --git a/docs/three/MF/V3/Tasks/SetProjector.html b/docs/three/MF/V3/Tasks/SetProjector.html
diff --git a/docs/three/MF/V3/Tasks/Shutdown.html b/docs/three/MF/V3/Tasks/Shutdown.html
diff --git a/docs/three/MF/V3/Tasks/SplitGroup.html b/docs/three/MF/V3/Tasks/SplitGroup.html
diff --git a/docs/three/MF/V3/Tasks/StartVideo.html b/docs/three/MF/V3/Tasks/StartVideo.html
diff --git a/docs/three/MF/V3/Tasks/StopVideo.html b/docs/three/MF/V3/Tasks/StopVideo.html
diff --git a/docs/three/MF/V3/Tasks/SystemInfo.html b/docs/three/MF/V3/Tasks/SystemInfo.html
diff --git a/docs/three/MF/V3/Tasks/TransformGroup.html b/docs/three/MF/V3/Tasks/TransformGroup.html
diff --git a/docs/three/MF/V3/Tasks/TurntableCalibration.html b/docs/three/MF/V3/Tasks/TurntableCalibration.html
diff --git a/docs/three/MF/V3/Tasks/UpdateSettings.html b/docs/three/MF/V3/Tasks/UpdateSettings.html
diff --git a/docs/three/MF/V3/Tasks/UploadProject.html b/docs/three/MF/V3/Tasks/UploadProject.html
diff --git a/docs/three/MF/V3/Three.html b/docs/three/MF/V3/Three.html
diff --git a/docs/three/_scanner.html b/docs/three/_scanner.html
diff --git a/docs/three/scanner.html b/docs/three/scanner.html
diff --git a/docs/three/serialization.html b/docs/three/serialization.html
diff --git a/three/make.bat → make.bat b/three/make.bat → make.bat
diff --git a/requirements.txt b/requirements.txt
@@ -7,5 +7,4 @@ pyflakes==3.2.0
 websocket-client==1.8.0
 wheel
 build
-sphinx
-sphinx-autodoc-typehints
+pdoc
diff --git a/scripts/build_doc.py b/scripts/build_doc.py
@@ -2,106 +2,29 @@
 
 import os
 import subprocess
-import glob
-import re
+import shutil
 
-# Paths
-scriptPath = os.path.dirname(os.path.realpath(__file__))
-protoInputPath = scriptPath + '/../V3Schema/'
-protoOutputPath = scriptPath + '/../three'
-docInputPath = scriptPath + '/../doc/source/'
-docOutputPath = scriptPath + '/../doc/build/'
-
-print("*****************")
-print("Proto files input         : " + protoInputPath)
-print("Proto files output        : " + protoOutputPath)
-print("Documentation files input : " + docInputPath)
-print("Documentation files output: " + docOutputPath)
-print("*****************")
-
-
-def BuildProtoFiles(protoFiles, inputDir, outputDir):
-    for file in protoFiles:
-        print("---> Building: " + file)
-
-    status = subprocess.run(args=[
-        'python3',
-        '-m',
-        'grpc_tools.protoc',
-        f'-I={inputDir}',
-        f'--python_betterproto_out={outputDir}',
-        '--experimental_allow_proto3_optional']
-        + protoFiles,
-        capture_output=True) 
-
-    return status
-
-def CleanUpGeneratedInit(file):
-    # Get the content
-    with open(file, "r") as f:
-        lines = f.readlines()
-    # Filter output
-    with open(file, "w") as f:
-        badImport = False
-        for line in lines:
-            # Beginning of the imports ?
-            if 'from ....' in line:
-                badImport = True
-            # Outside of the import section ?
-            if not badImport:
-                if 'MfV3' in line:
-                    line = re.sub('"[_]{3,}MfV3Settings', '"MF.V3.Settings.', line)
-                    line = re.sub('"[_]{3,}MfV3Descriptors', '"MF.V3.Descriptors.', line)
-                    line = line.replace('__"', '"')
-                f.write(line)
-            # End of the imports
-            if badImport and ')' in line:
-                badImport = False
-
-# Save the three/__init__.py
-# It will be overridden by the betterprotoc compiler
-initFilePath = scriptPath + "/../three/__init__.py"
-initFilePathBack = initFilePath+'.back'
-os.rename(initFilePath, initFilePathBack)
-
-# Find and build all the proto files
-protoFiles = glob.glob(protoInputPath+"/**/*.proto", recursive=True)
-result = BuildProtoFiles(protoFiles, protoInputPath, protoOutputPath)
-
-# Restore three/__init__.py
-os.rename(initFilePathBack, initFilePath)
-
-# Inspect the results
+# Define color variables
 GREEN = '\033[92m'
-YELLOW = '\033[33m'
+YELLOW = '\033[93m'
 RED = '\033[91m'
 ENDC = '\033[0m'
-print("*****************")
-if result.returncode == 0:
-    print(result.stdout.decode('utf-8'))
-    print(GREEN + 'Built : ' + str(len(protoFiles)) + ' proto files' + ENDC)
-else:
-    print('Build failed:')
-    print(RED + result.stderr.decode('utf-8') + ENDC)
-    exit(result.returncode)
-print("*****************")
 
+# Paths
+scriptPath = os.path.dirname(os.path.realpath(__file__))
+docOutputPath = scriptPath + '/../docs'
+module = 'three'
 
-# Clean up the generated code
-generatedFiles = glob.glob(protoOutputPath+"/MF/**/__init__.py", recursive=True)
-for file in generatedFiles:
-    print('Clean up: ', file)
-    CleanUpGeneratedInit(file)
-print("*****************")
+# Remove the docOutputPath if it exists
+if os.path.exists(docOutputPath):
+    shutil.rmtree(docOutputPath)
 
 # Build the documentation
 result = subprocess.run(args=[
-    'sphinx-build',
-    '-M',
-    'html',
-    docInputPath,
+    'pdoc',
+    '-o',
     docOutputPath,
-    '--write-all'],
+    module],
     capture_output=True)
 
 if result.returncode == 0:
@@ -110,12 +33,4 @@ def CleanUpGeneratedInit(file):
 else:
     print('Doc failed')
     print(GREEN + result.stdout.decode('utf-8') + ENDC)
-    print(RED + result.stderr.decode('utf-8') + ENDC)
-    exit(result.returncode)
-
-# Remove generated files
-for file in generatedFiles:
-    print('Remove:', file)
-    os.remove(file)
-
-
+    print(RED + result.stderr.decode('utf-8') + ENDC)
diff --git a/scripts/build_proto.py b/scripts/build_proto.py
@@ -26,7 +26,7 @@
     # Install the package in editable mode 
     subprocess.check_call([sys.executable, '-m', 'pip', 'install', '-e', '.'])
 
-    # Generate the proto files
-    subprocess.check_call([sys.executable, f'{scripts_folder}/generatePyi.py'])
+    # Generate the Scanner File
+    subprocess.check_call([sys.executable, f'{scripts_folder}/generateScannerPy.py'])
 
     exit(0)
diff --git a/scripts/generatePyi.py b/scripts/generatePyi.py
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,5 +7,4 @@ pyflakes==3.2.0 @@
     websocket-client==1.8.0
     wheel
     build
-    sphinx
-    sphinx-autodoc-typehints
+    pdoc