Skip to content

Commit ac70eb8

Browse files
glopesdevglopesdev
authored
Add pre-rendered workflow images for docs (#26)
* Update environment version to 2.9.0 We also remove bootstrap scripts as they are not needed either for CI or modern environment restore. * Ignore local editor settings * Allow publishing docs manually * Add pre-rendered workflow images for docs The native DAQmx dependencies cannot currently be reproduced in CI so we revert to manually exporting images in this case.
1 parent 54f63a5 commit ac70eb8

16 files changed

+350
-74
lines changed

‎.bonsai/Bonsai.config‎

Lines changed: 40 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<PackageConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
33
<Packages>
4-
<Package id="Bonsai" version="2.8.5" />
5-
<Package id="Bonsai.Core" version="2.8.5" />
6-
<Package id="Bonsai.Design" version="2.8.5" />
7-
<Package id="Bonsai.Dsp" version="2.8.1" />
8-
<Package id="Bonsai.Editor" version="2.8.5" />
9-
<Package id="Bonsai.System" version="2.8.1" />
4+
<Package id="Bonsai" version="2.9.0" />
5+
<Package id="Bonsai.Core" version="2.9.0" />
6+
<Package id="Bonsai.Design" version="2.9.0" />
7+
<Package id="Bonsai.Dsp" version="2.9.0" />
8+
<Package id="Bonsai.Editor" version="2.9.0" />
9+
<Package id="Bonsai.System" version="2.9.0" />
10+
<Package id="DockPanelSuite" version="3.1.1" />
11+
<Package id="DockPanelSuite.ThemeVS2015" version="3.1.1" />
1012
<Package id="jacobslusser.ScintillaNET" version="3.6.3" />
11-
<Package id="Markdig" version="0.18.1" />
12-
<Package id="Microsoft.Web.WebView2" version="1.0.1823.32" />
13+
<Package id="Markdig" version="0.41.1" />
14+
<Package id="Microsoft.Web.WebView2" version="1.0.2792.45" />
1315
<Package id="OpenCV.Net" version="3.4.2" />
1416
<Package id="Rx-Core" version="2.2.5" />
1517
<Package id="Rx-Interfaces" version="2.2.5" />
1618
<Package id="Rx-Linq" version="2.2.5" />
1719
<Package id="Rx-PlatformServices" version="2.2.5" />
18-
<Package id="SvgNet" version="3.3.3" />
19-
<Package id="System.Buffers" version="4.5.1" />
20-
<Package id="System.Memory" version="4.5.5" />
21-
<Package id="System.Numerics.Vectors" version="4.5.0" />
20+
<Package id="SvgNet" version="3.5.0" />
21+
<Package id="System.Buffers" version="4.6.0" />
22+
<Package id="System.Memory" version="4.6.0" />
23+
<Package id="System.Numerics.Vectors" version="4.6.0" />
2224
<Package id="System.Resources.Extensions" version="8.0.0" />
23-
<Package id="System.Runtime.CompilerServices.Unsafe" version="4.5.3" />
24-
<Package id="YamlDotNet" version="13.1.1" />
25+
<Package id="System.Runtime.CompilerServices.Unsafe" version="6.1.0" />
26+
<Package id="YamlDotNet" version="16.3.0" />
2527
</Packages>
2628
<AssemblyReferences>
2729
<AssemblyReference assemblyName="Bonsai" />
@@ -32,37 +34,39 @@
3234
<AssemblyReference assemblyName="Bonsai.System" />
3335
</AssemblyReferences>
3436
<AssemblyLocations>
35-
<AssemblyLocation assemblyName="Bonsai" processorArchitecture="MSIL" location="Packages/Bonsai.2.8.5/lib/net48/Bonsai.exe" />
36-
<AssemblyLocation assemblyName="Bonsai.Core" processorArchitecture="MSIL" location="Packages/Bonsai.Core.2.8.5/lib/net462/Bonsai.Core.dll" />
37-
<AssemblyLocation assemblyName="Bonsai.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Design.2.8.5/lib/net462/Bonsai.Design.dll" />
38-
<AssemblyLocation assemblyName="Bonsai.Dsp" processorArchitecture="MSIL" location="Packages/Bonsai.Dsp.2.8.1/lib/net462/Bonsai.Dsp.dll" />
39-
<AssemblyLocation assemblyName="Bonsai.Editor" processorArchitecture="MSIL" location="Packages/Bonsai.Editor.2.8.5/lib/net472/Bonsai.Editor.dll" />
40-
<AssemblyLocation assemblyName="Bonsai.System" processorArchitecture="MSIL" location="Packages/Bonsai.System.2.8.1/lib/net462/Bonsai.System.dll" />
41-
<AssemblyLocation assemblyName="Markdig" processorArchitecture="MSIL" location="Packages/Markdig.0.18.1/lib/net40/Markdig.dll" />
42-
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.Core" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.1823.32/lib/net45/Microsoft.Web.WebView2.Core.dll" />
43-
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.WinForms" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.1823.32/lib/net45/Microsoft.Web.WebView2.WinForms.dll" />
44-
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.Wpf" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.1823.32/lib/net45/Microsoft.Web.WebView2.Wpf.dll" />
37+
<AssemblyLocation assemblyName="Bonsai" processorArchitecture="MSIL" location="Packages/Bonsai.2.9.0/lib/net48/Bonsai.exe" />
38+
<AssemblyLocation assemblyName="Bonsai.Core" processorArchitecture="MSIL" location="Packages/Bonsai.Core.2.9.0/lib/net472/Bonsai.Core.dll" />
39+
<AssemblyLocation assemblyName="Bonsai.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Design.2.9.0/lib/net472/Bonsai.Design.dll" />
40+
<AssemblyLocation assemblyName="Bonsai.Dsp" processorArchitecture="MSIL" location="Packages/Bonsai.Dsp.2.9.0/lib/net472/Bonsai.Dsp.dll" />
41+
<AssemblyLocation assemblyName="Bonsai.Editor" processorArchitecture="MSIL" location="Packages/Bonsai.Editor.2.9.0/lib/net472/Bonsai.Editor.dll" />
42+
<AssemblyLocation assemblyName="Bonsai.System" processorArchitecture="MSIL" location="Packages/Bonsai.System.2.9.0/lib/net472/Bonsai.System.dll" />
43+
<AssemblyLocation assemblyName="Markdig" processorArchitecture="MSIL" location="Packages/Markdig.0.41.1/lib/net462/Markdig.dll" />
44+
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.Core" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.2792.45/lib/net462/Microsoft.Web.WebView2.Core.dll" />
45+
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.WinForms" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.2792.45/lib/net462/Microsoft.Web.WebView2.WinForms.dll" />
46+
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.Wpf" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.2792.45/lib/net462/Microsoft.Web.WebView2.Wpf.dll" />
4547
<AssemblyLocation assemblyName="OpenCV.Net" processorArchitecture="MSIL" location="Packages/OpenCV.Net.3.4.2/lib/net462/OpenCV.Net.dll" />
4648
<AssemblyLocation assemblyName="ScintillaNET" processorArchitecture="MSIL" location="Packages/jacobslusser.ScintillaNET.3.6.3/lib/net40/ScintillaNET.dll" />
47-
<AssemblyLocation assemblyName="SVG" processorArchitecture="MSIL" location="Packages/SvgNet.3.3.3/lib/net462/SVG.dll" />
48-
<AssemblyLocation assemblyName="System.Buffers" processorArchitecture="MSIL" location="Packages/System.Buffers.4.5.1/lib/net461/System.Buffers.dll" />
49-
<AssemblyLocation assemblyName="System.Memory" processorArchitecture="MSIL" location="Packages/System.Memory.4.5.5/lib/net461/System.Memory.dll" />
50-
<AssemblyLocation assemblyName="System.Numerics.Vectors" processorArchitecture="MSIL" location="Packages/System.Numerics.Vectors.4.5.0/lib/net46/System.Numerics.Vectors.dll" />
49+
<AssemblyLocation assemblyName="SVG" processorArchitecture="MSIL" location="Packages/SvgNet.3.5.0/lib/net462/SVG.dll" />
50+
<AssemblyLocation assemblyName="System.Buffers" processorArchitecture="MSIL" location="Packages/System.Buffers.4.6.0/lib/net462/System.Buffers.dll" />
51+
<AssemblyLocation assemblyName="System.Memory" processorArchitecture="MSIL" location="Packages/System.Memory.4.6.0/lib/net462/System.Memory.dll" />
52+
<AssemblyLocation assemblyName="System.Numerics.Vectors" processorArchitecture="MSIL" location="Packages/System.Numerics.Vectors.4.6.0/lib/net462/System.Numerics.Vectors.dll" />
5153
<AssemblyLocation assemblyName="System.Reactive.Core" processorArchitecture="MSIL" location="Packages/Rx-Core.2.2.5/lib/net45/System.Reactive.Core.dll" />
5254
<AssemblyLocation assemblyName="System.Reactive.Interfaces" processorArchitecture="MSIL" location="Packages/Rx-Interfaces.2.2.5/lib/net45/System.Reactive.Interfaces.dll" />
5355
<AssemblyLocation assemblyName="System.Reactive.Linq" processorArchitecture="MSIL" location="Packages/Rx-Linq.2.2.5/lib/net45/System.Reactive.Linq.dll" />
5456
<AssemblyLocation assemblyName="System.Reactive.PlatformServices" processorArchitecture="MSIL" location="Packages/Rx-PlatformServices.2.2.5/lib/net45/System.Reactive.PlatformServices.dll" />
5557
<AssemblyLocation assemblyName="System.Resources.Extensions" processorArchitecture="MSIL" location="Packages/System.Resources.Extensions.8.0.0/lib/net462/System.Resources.Extensions.dll" />
56-
<AssemblyLocation assemblyName="System.Runtime.CompilerServices.Unsafe" processorArchitecture="MSIL" location="Packages/System.Runtime.CompilerServices.Unsafe.4.5.3/lib/net461/System.Runtime.CompilerServices.Unsafe.dll" />
57-
<AssemblyLocation assemblyName="YamlDotNet" processorArchitecture="MSIL" location="Packages/YamlDotNet.13.1.1/lib/net47/YamlDotNet.dll" />
58+
<AssemblyLocation assemblyName="System.Runtime.CompilerServices.Unsafe" processorArchitecture="MSIL" location="Packages/System.Runtime.CompilerServices.Unsafe.6.1.0/lib/net462/System.Runtime.CompilerServices.Unsafe.dll" />
59+
<AssemblyLocation assemblyName="WeifenLuo.WinFormsUI.Docking" processorArchitecture="MSIL" location="Packages/DockPanelSuite.3.1.1/lib/net40/WeifenLuo.WinFormsUI.Docking.dll" />
60+
<AssemblyLocation assemblyName="WeifenLuo.WinFormsUI.Docking.ThemeVS2015" processorArchitecture="MSIL" location="Packages/DockPanelSuite.ThemeVS2015.3.1.1/lib/net40/WeifenLuo.WinFormsUI.Docking.ThemeVS2015.dll" />
61+
<AssemblyLocation assemblyName="YamlDotNet" processorArchitecture="MSIL" location="Packages/YamlDotNet.16.3.0/lib/net47/YamlDotNet.dll" />
5862
</AssemblyLocations>
5963
<LibraryFolders>
60-
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-arm64/native" platform="arm64" />
61-
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-arm64/native_uap" platform="arm64" />
62-
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-x64/native" platform="x64" />
63-
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-x64/native_uap" platform="x64" />
64-
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-x86/native" platform="x86" />
65-
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.1823.32/runtimes/win-x86/native_uap" platform="x86" />
64+
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.2792.45/runtimes/win-arm64/native" platform="arm64" />
65+
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.2792.45/runtimes/win-arm64/native_uap" platform="arm64" />
66+
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.2792.45/runtimes/win-x64/native" platform="x64" />
67+
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.2792.45/runtimes/win-x64/native_uap" platform="x64" />
68+
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.2792.45/runtimes/win-x86/native" platform="x86" />
69+
<LibraryFolder path="Packages/Microsoft.Web.WebView2.1.0.2792.45/runtimes/win-x86/native_uap" platform="x86" />
6670
<LibraryFolder path="Packages/OpenCV.Net.3.4.2/runtimes/win-x64/native/vc14/bin" platform="x64" />
6771
<LibraryFolder path="Packages/OpenCV.Net.3.4.2/runtimes/win-x86/native/vc14/bin" platform="x86" />
6872
</LibraryFolders>

‎.bonsai/NuGet.config‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<?xml version="1.0" encoding="utf-8"?>
1+
<?xml version="1.0" encoding="utf-8"?>
22
<configuration>
33
<packageSources>
44
</packageSources>
5-
</configuration>
5+
</configuration>

‎.bonsai/Setup.cmd‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎.bonsai/Setup.ps1‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎.github/workflows/Bonsai.DAQmx.yml‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,15 @@ name: Bonsai.DAQmx
1515
on:
1616
push:
1717
# This prevents tag pushes from triggering this workflow
18-
branches: ['*']
18+
branches: ['**']
1919
pull_request:
2020
release:
2121
types: [published]
2222
workflow_dispatch:
23+
inputs:
24+
publish-documentation:
25+
description: "Publish documentation to GitHub Pages?"
26+
default: "false"
2327
env:
2428
DOTNET_NOLOGO: true
2529
DOTNET_CLI_TELEMETRY_OPTOUT: true
@@ -314,6 +318,7 @@ jobs:
314318
if: |
315319
!cancelled() && !failure() && needs.build-documentation.result == 'success'
316320
&& (github.event_name == 'release'
321+
|| (github.event_name == 'workflow_dispatch' && github.event.inputs.publish-documentation == 'true')
317322
|| (vars.CONTINUOUS_DOCUMENTATION && github.event_name != 'pull_request')
318323
)
319324
steps:
@@ -337,8 +342,7 @@ jobs:
337342
with:
338343
path: '.'
339344

340-
# ----------------------------------------------------------------------- Publish to GitHub Pages (for forks)
341-
- name: Publish to GitHub Pages (forks)
345+
# ----------------------------------------------------------------------- Publish to GitHub Pages
346+
- name: Publish to GitHub Pages
342347
id: publish
343-
if: github.event_name == 'release' || github.event.repository.fork
344-
uses: actions/deploy-pages@v4
348+
uses: actions/deploy-pages@v4

‎docs/build.ps1‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,8 @@ $PSNativeCommandUseErrorActionPreference = $true
77

88
Push-Location $PSScriptRoot
99
try {
10-
$libPaths = @()
11-
$libPaths += Get-ChildItem "..\artifacts\bin\*\release_net4*" -Directory | Select-Object -Expand FullName
12-
$libPaths += "..\artifacts\package\release"
13-
14-
./export-images.ps1 $libPaths
10+
# We cannot currently automatically render images in CI for this package since it depends on device drivers
11+
# ./export-images.ps1 $libPaths
1512
dotnet docfx metadata
1613
dotnet docfx build $docfxArgs
1714
} finally {

‎docs/workflows/.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1+
.bonsai/
12
*.layout
2-
*.svg

‎docs/workflows/AnalogInput-Async.svg‎

Lines changed: 23 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)