Skip to content

Commit 7ab6756

Browse files
glopesdevglopesdev
authored
Merge pull request bonsai-rx#14 from glopesdev/docs-update
Update documentation website and move to modern template
2 parents b3dba77 + bde686b commit 7ab6756

30 files changed

Lines changed: 253 additions & 299 deletions

‎.bonsai/Bonsai.config‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<PackageConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3+
<Packages>
4+
<Package id="Bonsai" version="2.8.2" />
5+
<Package id="Bonsai.Core" version="2.8.1" />
6+
<Package id="Bonsai.Design" version="2.8.0" />
7+
<Package id="Bonsai.Editor" version="2.8.1" />
8+
<Package id="Bonsai.Windows.Input" version="2.7.0" />
9+
<Package id="jacobslusser.ScintillaNET" version="3.6.3" />
10+
<Package id="Markdig" version="0.18.1" />
11+
<Package id="Microsoft.Web.WebView2" version="1.0.1823.32" />
12+
<Package id="Rx-Core" version="2.2.5" />
13+
<Package id="Rx-Interfaces" version="2.2.5" />
14+
<Package id="Rx-Linq" version="2.2.5" />
15+
<Package id="Rx-PlatformServices" version="2.2.5" />
16+
<Package id="SvgNet" version="3.3.3" />
17+
<Package id="YamlDotNet" version="13.1.1" />
18+
</Packages>
19+
<AssemblyReferences>
20+
<AssemblyReference assemblyName="Bonsai" />
21+
<AssemblyReference assemblyName="Bonsai.Core" />
22+
<AssemblyReference assemblyName="Bonsai.Design" />
23+
<AssemblyReference assemblyName="Bonsai.Editor" />
24+
<AssemblyReference assemblyName="Bonsai.Windows.Input" />
25+
</AssemblyReferences>
26+
<AssemblyLocations>
27+
<AssemblyLocation assemblyName="Bonsai" processorArchitecture="MSIL" location="Packages\Bonsai.2.8.2\lib\net48\Bonsai.exe" />
28+
<AssemblyLocation assemblyName="Bonsai.Core" processorArchitecture="MSIL" location="Packages\Bonsai.Core.2.8.1\lib\net462\Bonsai.Core.dll" />
29+
<AssemblyLocation assemblyName="Bonsai.Design" processorArchitecture="MSIL" location="Packages\Bonsai.Design.2.8.0\lib\net462\Bonsai.Design.dll" />
30+
<AssemblyLocation assemblyName="Bonsai.Editor" processorArchitecture="MSIL" location="Packages\Bonsai.Editor.2.8.1\lib\net472\Bonsai.Editor.dll" />
31+
<AssemblyLocation assemblyName="Bonsai.Windows.Input" processorArchitecture="MSIL" location="Packages\Bonsai.Windows.Input.2.7.0\lib\net462\Bonsai.Windows.Input.dll" />
32+
<AssemblyLocation assemblyName="Markdig" processorArchitecture="MSIL" location="Packages\Markdig.0.18.1\lib\net40\Markdig.dll" />
33+
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.Core" processorArchitecture="MSIL" location="Packages\Microsoft.Web.WebView2.1.0.1823.32\lib\net45\Microsoft.Web.WebView2.Core.dll" />
34+
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.WinForms" processorArchitecture="MSIL" location="Packages\Microsoft.Web.WebView2.1.0.1823.32\lib\net45\Microsoft.Web.WebView2.WinForms.dll" />
35+
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.Wpf" processorArchitecture="MSIL" location="Packages\Microsoft.Web.WebView2.1.0.1823.32\lib\net45\Microsoft.Web.WebView2.Wpf.dll" />
36+
<AssemblyLocation assemblyName="ScintillaNET" processorArchitecture="MSIL" location="Packages\jacobslusser.ScintillaNET.3.6.3\lib\net40\ScintillaNET.dll" />
37+
<AssemblyLocation assemblyName="SVG" processorArchitecture="MSIL" location="Packages\SvgNet.3.3.3\lib\net462\SVG.dll" />
38+
<AssemblyLocation assemblyName="System.Reactive.Core" processorArchitecture="MSIL" location="Packages\Rx-Core.2.2.5\lib\net45\System.Reactive.Core.dll" />
39+
<AssemblyLocation assemblyName="System.Reactive.Interfaces" processorArchitecture="MSIL" location="Packages\Rx-Interfaces.2.2.5\lib\net45\System.Reactive.Interfaces.dll" />
40+
<AssemblyLocation assemblyName="System.Reactive.Linq" processorArchitecture="MSIL" location="Packages\Rx-Linq.2.2.5\lib\net45\System.Reactive.Linq.dll" />
41+
<AssemblyLocation assemblyName="System.Reactive.PlatformServices" processorArchitecture="MSIL" location="Packages\Rx-PlatformServices.2.2.5\lib\net45\System.Reactive.PlatformServices.dll" />
42+
<AssemblyLocation assemblyName="YamlDotNet" processorArchitecture="MSIL" location="Packages\YamlDotNet.13.1.1\lib\net47\YamlDotNet.dll" />
43+
</AssemblyLocations>
44+
<LibraryFolders>
45+
<LibraryFolder path="Packages\Microsoft.Web.WebView2.1.0.1823.32\runtimes\win-arm64\native" platform="arm64" />
46+
<LibraryFolder path="Packages\Microsoft.Web.WebView2.1.0.1823.32\runtimes\win-arm64\native_uap" platform="arm64" />
47+
<LibraryFolder path="Packages\Microsoft.Web.WebView2.1.0.1823.32\runtimes\win-x64\native" platform="x64" />
48+
<LibraryFolder path="Packages\Microsoft.Web.WebView2.1.0.1823.32\runtimes\win-x64\native_uap" platform="x64" />
49+
<LibraryFolder path="Packages\Microsoft.Web.WebView2.1.0.1823.32\runtimes\win-x86\native" platform="x86" />
50+
<LibraryFolder path="Packages\Microsoft.Web.WebView2.1.0.1823.32\runtimes\win-x86\native_uap" platform="x86" />
51+
</LibraryFolders>
52+
</PackageConfiguration>

‎.bonsai/NuGet.config‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<configuration>
3+
<packageSources>
4+
<add key="Gallery" value="Gallery" />
5+
<add key="Bonsai Packages" value="https://www.myget.org/F/bonsai/api/v3/index.json" />
6+
<add key="Community Packages" value="https://www.myget.org/F/bonsai-community/api/v3/index.json" />
7+
</packageSources>
8+
</configuration>

‎.bonsai/Setup.cmd‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
@echo off
2+
pushd %~dp0
3+
powershell -ExecutionPolicy Bypass -File ./Setup.ps1
4+
popd

‎.bonsai/Setup.ps1‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Push-Location $PSScriptRoot
2+
if (!(Test-Path "./Bonsai.exe")) {
3+
$release = "https://github.com/bonsai-rx/bonsai/releases/latest/download/Bonsai.zip"
4+
$configPath = "./Bonsai.config"
5+
if (Test-Path $configPath) {
6+
[xml]$config = Get-Content $configPath
7+
$bootstrapper = $config.PackageConfiguration.Packages.Package.where{$_.id -eq 'Bonsai'}
8+
if ($bootstrapper) {
9+
$version = $bootstrapper.version
10+
$release = "https://github.com/bonsai-rx/bonsai/releases/download/$version/Bonsai.zip"
11+
}
12+
}
13+
Invoke-WebRequest $release -OutFile "temp.zip"
14+
Move-Item -Path "NuGet.config" "temp.config" -ErrorAction SilentlyContinue
15+
Expand-Archive "temp.zip" -DestinationPath "." -Force
16+
Move-Item -Path "temp.config" "NuGet.config" -Force -ErrorAction SilentlyContinue
17+
Remove-Item -Path "temp.zip"
18+
Remove-Item -Path "Bonsai32.exe"
19+
}
20+
& .\Bonsai.exe --no-editor
21+
Pop-Location

‎.config/dotnet-tools.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"version": 1,
3+
"isRoot": true,
4+
"tools": {
5+
"docfx": {
6+
"version": "2.75.3",
7+
"commands": [
8+
"docfx"
9+
]
10+
}
11+
}
12+
}

‎.github/workflows/docs.yml‎

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,43 @@ jobs:
88
build:
99
runs-on: windows-latest
1010
steps:
11-
- uses: actions/checkout@v2
12-
11+
- name: Checkout
12+
uses: actions/checkout@v4.1.1
13+
with:
14+
submodules: true
15+
1316
- name: Setup MSBuild
14-
uses: microsoft/setup-msbuild@v1
15-
17+
uses: microsoft/setup-msbuild@v2
18+
1619
- name: Restore NuGet Packages
17-
run: msbuild -t:restore src\Bonsai.Scripting.Python.sln
20+
run: msbuild -t:restore src/Bonsai.Scripting.Python.sln
1821

19-
- name: Setup DocFX
20-
uses: crazy-max/ghaction-chocolatey@v1
22+
- name: Build Solution
23+
run: msbuild src/Bonsai.Scripting.Python.sln /p:Configuration=Release
24+
25+
- name: Setup .NET Core SDK
26+
uses: actions/setup-dotnet@v4.0.0
2127
with:
22-
args: install docfx
28+
dotnet-version: 7.x
29+
30+
- name: Setup DocFX
31+
run: dotnet tool restore
2332

33+
- name: Setup Bonsai
34+
working-directory: .bonsai
35+
run: .\Setup.ps1
36+
2437
- name: Build Documentation
25-
run: docfx docs/docfx.json
38+
working-directory: docs
39+
run: .\build.ps1
2640

2741
- name: Checkout gh-pages
28-
uses: actions/checkout@v2
42+
uses: actions/checkout@v4.1.1
2943
with:
3044
ref: gh-pages
3145
path: gh-pages
3246
- name: Publish to github pages
33-
uses: peaceiris/actions-gh-pages@v3
47+
uses: peaceiris/actions-gh-pages@v3.9.3
3448
with:
3549
github_token: ${{ secrets.GITHUB_TOKEN }}
3650
publish_dir: docs/_site

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
.vs
2+
.venv
23
bin
34
obj
5+
Packages
6+
*.exe
7+
*.exe.*
48
*.user
59
*.suo

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "docs/bonsai"]
2+
path = docs/bonsai
3+
url = https://github.com/bonsai-rx/docfx-tools

‎docs/articles/intro.md‎

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

‎docs/articles/overview.md‎

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

0 commit comments

Comments
 (0)