Migrate documentation website to docfx

.bonsai/.gitignore

@@ -0,0 +1,3 @@
+*.exe
+*.exe.*
+Packages

.bonsai/Bonsai.config

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="utf-8"?>
+<PackageConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <Packages>
+    <Package id="AssimpNet" version="4.1.0" />
+    <Package id="Bonsai" version="2.8.5" />
+    <Package id="Bonsai.Arduino" version="2.8.1" />
+    <Package id="Bonsai.Core" version="2.8.5" />
+    <Package id="Bonsai.Design" version="2.8.5" />
+    <Package id="Bonsai.Dsp" version="2.7.0" />
+    <Package id="Bonsai.Editor" version="2.8.5" />
+    <Package id="Bonsai.Numerics" version="0.7.0" />
+    <Package id="Bonsai.Scripting.Expressions" version="2.7.0" />
+    <Package id="Bonsai.Shaders" version="0.26.0" />
+    <Package id="Bonsai.Shaders.Design" version="0.26.0" />
+    <Package id="Bonsai.Shaders.Rendering" version="0.3.0" />
+    <Package id="Bonsai.System" version="2.8.1" />
+    <Package id="Bonsai.System.Design" version="2.7.0" />
+    <Package id="Bonsai.Vision" version="2.7.0" />
+    <Package id="Bonsai.VR" version="0.6.0" />
+    <Package id="BonVision" version="0.11.0" />
+    <Package id="jacobslusser.ScintillaNET" version="3.6.3" />
+    <Package id="Markdig" version="0.18.1" />
+    <Package id="MathNet.Numerics" version="4.5.1" />
+    <Package id="Microsoft.Web.WebView2" version="1.0.1823.32" />
+    <Package id="OpenCV.Net" version="3.4.1" />
+    <Package id="OpenTK" version="3.1.0" />
+    <Package id="Rx-Core" version="2.2.5" />
+    <Package id="Rx-Interfaces" version="2.2.5" />
+    <Package id="Rx-Linq" version="2.2.5" />
+    <Package id="Rx-PlatformServices" version="2.2.5" />
+    <Package id="SvgNet" version="3.3.3" />
+    <Package id="System.Buffers" version="4.5.1" />
+    <Package id="System.Linq.Dynamic" version="1.0.7" />
+    <Package id="System.Memory" version="4.5.5" />
+    <Package id="System.Numerics.Vectors" version="4.5.0" />
+    <Package id="System.Resources.Extensions" version="8.0.0" />
+    <Package id="System.Runtime.CompilerServices.Unsafe" version="4.5.3" />
+    <Package id="YamlDotNet" version="13.1.1" />
+  </Packages>
+  <AssemblyReferences>
+    <AssemblyReference assemblyName="Bonsai" />
+    <AssemblyReference assemblyName="Bonsai.Arduino" />
+    <AssemblyReference assemblyName="Bonsai.Core" />
+    <AssemblyReference assemblyName="Bonsai.Design" />
+    <AssemblyReference assemblyName="Bonsai.Dsp" />
+    <AssemblyReference assemblyName="Bonsai.Editor" />
+    <AssemblyReference assemblyName="Bonsai.Numerics" />
+    <AssemblyReference assemblyName="Bonsai.Scripting.Expressions" />
+    <AssemblyReference assemblyName="Bonsai.Shaders" />
+    <AssemblyReference assemblyName="Bonsai.Shaders.Design" />
+    <AssemblyReference assemblyName="Bonsai.Shaders.Rendering" />
+    <AssemblyReference assemblyName="Bonsai.System" />
+    <AssemblyReference assemblyName="Bonsai.System.Design" />
+    <AssemblyReference assemblyName="Bonsai.Vision" />
+    <AssemblyReference assemblyName="Bonsai.VR" />
+    <AssemblyReference assemblyName="BonVision" />
+  </AssemblyReferences>
+  <AssemblyLocations>
+    <AssemblyLocation assemblyName="AssimpNet" processorArchitecture="MSIL" location="Packages/AssimpNet.4.1.0/lib/net40/AssimpNet.dll" />
+    <AssemblyLocation assemblyName="Bonsai" processorArchitecture="MSIL" location="Packages/Bonsai.2.8.5/lib/net48/Bonsai.exe" />
+    <AssemblyLocation assemblyName="Bonsai.Arduino" processorArchitecture="MSIL" location="Packages/Bonsai.Arduino.2.8.1/lib/net462/Bonsai.Arduino.dll" />
+    <AssemblyLocation assemblyName="Bonsai.Core" processorArchitecture="MSIL" location="Packages/Bonsai.Core.2.8.5/lib/net462/Bonsai.Core.dll" />
+    <AssemblyLocation assemblyName="Bonsai.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Design.2.8.5/lib/net462/Bonsai.Design.dll" />
+    <AssemblyLocation assemblyName="Bonsai.Dsp" processorArchitecture="MSIL" location="Packages/Bonsai.Dsp.2.7.0/lib/net462/Bonsai.Dsp.dll" />
+    <AssemblyLocation assemblyName="Bonsai.Editor" processorArchitecture="MSIL" location="Packages/Bonsai.Editor.2.8.5/lib/net472/Bonsai.Editor.dll" />
+    <AssemblyLocation assemblyName="Bonsai.Numerics" processorArchitecture="MSIL" location="Packages/Bonsai.Numerics.0.7.0/lib/net462/Bonsai.Numerics.dll" />
+    <AssemblyLocation assemblyName="Bonsai.Scripting.Expressions" processorArchitecture="MSIL" location="Packages/Bonsai.Scripting.Expressions.2.7.0/lib/net462/Bonsai.Scripting.Expressions.dll" />
+    <AssemblyLocation assemblyName="Bonsai.Shaders" processorArchitecture="MSIL" location="Packages/Bonsai.Shaders.0.26.0/lib/net462/Bonsai.Shaders.dll" />
+    <AssemblyLocation assemblyName="Bonsai.Shaders.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Shaders.Design.0.26.0/lib/net462/Bonsai.Shaders.Design.dll" />
+    <AssemblyLocation assemblyName="Bonsai.Shaders.Rendering" processorArchitecture="MSIL" location="Packages/Bonsai.Shaders.Rendering.0.3.0/lib/net462/Bonsai.Shaders.Rendering.dll" />
+    <AssemblyLocation assemblyName="Bonsai.System" processorArchitecture="MSIL" location="Packages/Bonsai.System.2.8.1/lib/net462/Bonsai.System.dll" />
+    <AssemblyLocation assemblyName="Bonsai.System.Design" processorArchitecture="MSIL" location="Packages/Bonsai.System.Design.2.7.0/lib/net462/Bonsai.System.Design.dll" />
+    <AssemblyLocation assemblyName="Bonsai.Vision" processorArchitecture="MSIL" location="Packages/Bonsai.Vision.2.7.0/lib/net462/Bonsai.Vision.dll" />
+    <AssemblyLocation assemblyName="Bonsai.VR" processorArchitecture="MSIL" location="Packages/Bonsai.VR.0.6.0/lib/net45/Bonsai.VR.dll" />
+    <AssemblyLocation assemblyName="BonVision" processorArchitecture="MSIL" location="Packages/BonVision.0.11.0/lib/net462/BonVision.dll" />
+    <AssemblyLocation assemblyName="Markdig" processorArchitecture="MSIL" location="Packages/Markdig.0.18.1/lib/net40/Markdig.dll" />
+    <AssemblyLocation assemblyName="MathNet.Numerics" processorArchitecture="MSIL" location="Packages/MathNet.Numerics.4.5.1/lib/net461/MathNet.Numerics.dll" />
+    <AssemblyLocation assemblyName="Microsoft.Web.WebView2.Core" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.1823.32/lib/net45/Microsoft.Web.WebView2.Core.dll" />
+    <AssemblyLocation assemblyName="Microsoft.Web.WebView2.WinForms" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.1823.32/lib/net45/Microsoft.Web.WebView2.WinForms.dll" />
+    <AssemblyLocation assemblyName="Microsoft.Web.WebView2.Wpf" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.1823.32/lib/net45/Microsoft.Web.WebView2.Wpf.dll" />
+    <AssemblyLocation assemblyName="OpenCV.Net" processorArchitecture="MSIL" location="Packages/OpenCV.Net.3.4.1/lib/net462/OpenCV.Net.dll" />
+    <AssemblyLocation assemblyName="OpenTK" processorArchitecture="MSIL" location="Packages/OpenTK.3.1.0/lib/net20/OpenTK.dll" />
+    <AssemblyLocation assemblyName="ScintillaNET" processorArchitecture="MSIL" location="Packages/jacobslusser.ScintillaNET.3.6.3/lib/net40/ScintillaNET.dll" />
+    <AssemblyLocation assemblyName="SVG" processorArchitecture="MSIL" location="Packages/SvgNet.3.3.3/lib/net462/SVG.dll" />
+    <AssemblyLocation assemblyName="System.Buffers" processorArchitecture="MSIL" location="Packages/System.Buffers.4.5.1/lib/net461/System.Buffers.dll" />
+    <AssemblyLocation assemblyName="System.Linq.Dynamic" processorArchitecture="MSIL" location="Packages/System.Linq.Dynamic.1.0.7/lib/net40/System.Linq.Dynamic.dll" />
+    <AssemblyLocation assemblyName="System.Memory" processorArchitecture="MSIL" location="Packages/System.Memory.4.5.5/lib/net461/System.Memory.dll" />
+    <AssemblyLocation assemblyName="System.Numerics.Vectors" processorArchitecture="MSIL" location="Packages/System.Numerics.Vectors.4.5.0/lib/net46/System.Numerics.Vectors.dll" />
+    <AssemblyLocation assemblyName="System.Reactive.Core" processorArchitecture="MSIL" location="Packages/Rx-Core.2.2.5/lib/net45/System.Reactive.Core.dll" />
+    <AssemblyLocation assemblyName="System.Reactive.Interfaces" processorArchitecture="MSIL" location="Packages/Rx-Interfaces.2.2.5/lib/net45/System.Reactive.Interfaces.dll" />
+    <AssemblyLocation assemblyName="System.Reactive.Linq" processorArchitecture="MSIL" location="Packages/Rx-Linq.2.2.5/lib/net45/System.Reactive.Linq.dll" />
+    <AssemblyLocation assemblyName="System.Reactive.PlatformServices" processorArchitecture="MSIL" location="Packages/Rx-PlatformServices.2.2.5/lib/net45/System.Reactive.PlatformServices.dll" />
+    <AssemblyLocation assemblyName="System.Resources.Extensions" processorArchitecture="MSIL" location="Packages/System.Resources.Extensions.8.0.0/lib/net462/System.Resources.Extensions.dll" />
+    <AssemblyLocation assemblyName="System.Runtime.CompilerServices.Unsafe" processorArchitecture="MSIL" location="Packages/System.Runtime.CompilerServices.Unsafe.4.5.3/lib/net461/System.Runtime.CompilerServices.Unsafe.dll" />
+    <AssemblyLocation assemblyName="YamlDotNet" processorArchitecture="MSIL" location="Packages/YamlDotNet.13.1.1/lib/net47/YamlDotNet.dll" />
+  </AssemblyLocations>
+  <LibraryFolders>
+    <LibraryFolder path="Packages/AssimpNet.4.1.0/runtimes/win-x64/native" platform="x64" />
+    <LibraryFolder path="Packages/AssimpNet.4.1.0/runtimes/win-x86/native" platform="x86" />
+    <LibraryFolder path="Packages/Bonsai.VR.0.6.0/build/native/bin/Win32" platform="x86" />
+    <LibraryFolder path="Packages/Bonsai.VR.0.6.0/build/native/bin/x64" platform="x64" />
+    <LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-arm64/native" platform="arm64" />
+    <LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-arm64/native_uap" platform="arm64" />
+    <LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-x64/native" platform="x64" />
+    <LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-x64/native_uap" platform="x64" />
+    <LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-x86/native" platform="x86" />
+    <LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-x86/native_uap" platform="x86" />
+    <LibraryFolder path="Packages/OpenCV.Net.3.4.1/runtimes/win-x64/native/vc14/bin" platform="x64" />
+    <LibraryFolder path="Packages/OpenCV.Net.3.4.1/runtimes/win-x86/native/vc14/bin" platform="x86" />
+  </LibraryFolders>
+</PackageConfiguration>

.bonsai/NuGet.config

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <add key="Gallery" value="Gallery" />
+    <add key="Bonsai Packages" value="https://www.myget.org/F/bonsai/api/v3/index.json" />
+    <add key="Community Packages" value="https://www.myget.org/F/bonsai-community/api/v3/index.json" />
+  </packageSources>
+</configuration>

.bonsai/Setup.cmd

@@ -0,0 +1,4 @@
+@echo off
+pushd %~dp0
+powershell -ExecutionPolicy Bypass -File ./Setup.ps1
+popd

.bonsai/Setup.ps1

@@ -0,0 +1,21 @@
+Push-Location $PSScriptRoot
+if (!(Test-Path "./Bonsai.exe")) {
+    $release = "https://github.com/bonsai-rx/bonsai/releases/latest/download/Bonsai.zip"
+    $configPath = "./Bonsai.config"
+    if (Test-Path $configPath) {
+        [xml]$config = Get-Content $configPath
+        $bootstrapper = $config.PackageConfiguration.Packages.Package.where{$_.id -eq 'Bonsai'}
+        if ($bootstrapper) {
+            $version = $bootstrapper.version
+            $release = "https://github.com/bonsai-rx/bonsai/releases/download/$version/Bonsai.zip"
+        }
+    }
+    Invoke-WebRequest $release -OutFile "temp.zip"
+    Move-Item -Path "NuGet.config" "temp.config" -ErrorAction SilentlyContinue
+    Expand-Archive "temp.zip" -DestinationPath "." -Force
+    Move-Item -Path "temp.config" "NuGet.config" -Force -ErrorAction SilentlyContinue
+    Remove-Item -Path "temp.zip"
+    Remove-Item -Path "Bonsai32.exe"
+}
+& .\Bonsai.exe --no-editor
+Pop-Location

.config/dotnet-tools.json

@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "docfx": {
+      "version": "2.77.0",
+      "commands": [
+        "docfx"
+      ]
+    }
+  }
+}

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Build
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Build Solution
+    runs-on: windows-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Setup MSBuild
+      uses: microsoft/setup-msbuild@v1
+
+    - name: Setup NuGet
+      uses: NuGet/[email protected]
+
+    - name: Restore NuGet Packages
+      run: nuget restore src/BonVision.sln
+
+    - name: Build Solution
+      run: msbuild src/BonVision.sln /p:Configuration=Release

.github/workflows/docs.yml

@@ -0,0 +1,59 @@
+# Builds and publishes the documentation website to gh-pages branch
+name: Build docs
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+        with:
+          submodules: true
+
+      - name: Setup .NET Core SDK
+        uses: actions/[email protected]
+        with:
+          dotnet-version: 8.x
+
+      - name: Setup MSBuild
+        uses: microsoft/setup-msbuild@v2
+
+      - name: Restore NuGet Packages
+        run: msbuild -t:restore src/BonVision.sln
+
+      - name: Build Solution
+        run: msbuild src/BonVision.sln /p:Configuration=Release
+
+      - name: Setup DocFX
+        run: dotnet tool restore
+
+      - name: Setup Bonsai
+        working-directory: .bonsai
+        run: .\Setup.ps1
+
+      - name: Setup Python 
+        uses: actions/setup-python@v5
+        with: 
+          python-version: '3.12'
+
+      - name: Setup Pyyaml
+        run: pip install pyyaml==6.0.2
+
+      - name: Build Documentation
+        working-directory: docs
+        run: .\build.ps1
+
+      - name: Checkout gh-pages
+        uses: actions/[email protected]
+        with:
+          ref: gh-pages
+          path: gh-pages
+      - name: Publish to github pages
+        uses: peaceiris/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_site
+          force_orphan: true

.gitignore

@@ -1,4 +1,12 @@
 .vs
+.venv
 bin
 obj
-packages
+packages
+*.orig
+*.user
+*.suo
+*.exe
+*.exe.settings
+*.exe.old
+*.dll

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "docs/bonsai"]
+	path = docs/bonsai
+	url = https://github.com/banchan86/docfx-tools_dev
+	branch = api-template-includeworkflow