Merge pull request #19 from bonsai-rx/docs-dev

Add docfx documentation infrastructure

.config/dotnet-tools.json

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

.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+# 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\Bonsai.Gui.sln
+
+      - name: Setup DocFX
+        run: dotnet tool restore
+
+      - name: Build Documentation
+        run: dotnet docfx docs/docfx.json
+
+      - 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

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/bonsai"]
+	path = docs/bonsai
+	url = https://github.com/bonsai-rx/docfx-tools

docs/.gitignore

@@ -0,0 +1 @@
+_site

docs/api/.gitignore

@@ -0,0 +1,3 @@
+# auto-generated files
+*.yml
+.manifest

docs/articles/toc.yml

@@ -0,0 +1 @@
+- href: ../index.md

docs/docfx.json

@@ -0,0 +1,83 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../src",
+          "files": [
+            "**/*.csproj"
+          ]
+        }
+      ],
+      "dest": "api",
+      "filter": "filter.yml"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**",
+          "bonsai/**",
+          "filter.yml"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "logo.svg",
+          "favicon.ico",
+          "images/**",
+          "workflows/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "template": [
+      "default",
+      "modern",
+      "bonsai/template",
+      "template"
+    ],
+    "globalMetadata": {
+      "_appName": "Bonsai - GUI",
+      "_appTitle": "Bonsai.Gui",
+      "_enableNewTab": true,
+      "_enableSearch": true,
+      "pdf": false,
+      "_appFooter": "&copy; 2024 Bonsai Foundation CIC and Contributors. Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a>",
+      "_gitContribute": {
+        "repo": "https://github.com/bonsai-rx/gui",
+        "branch": "main",
+        "apiSpecFolder": "docs/apidoc"
+      }
+    },
+    "markdownEngineName": "markdig",
+    "markdownEngineProperties": {
+      "markdigExtensions": [
+        "attributes",
+        "customcontainers"
+      ]
+    },
+    "xref": [
+      "https://bonsai-rx.org/docs/xrefmap.yml",
+      "https://horizongir.github.io/ZedGraph/xrefmap.yml",
+      "https://horizongir.github.io/reactive/xrefmap.yml"
+    ]
+  }
+}

docs/filter.yml

@@ -0,0 +1,4 @@
+apiRules:
+- exclude:
+    hasAttribute:
+      uid: System.ObsoleteAttribute

docs/index.md

@@ -0,0 +1,3 @@
+# Getting Started
+
+`Bonsai.Gui` is a collection of packages for the [Bonsai](https://bonsai-rx.org/) visual programming language for quickly composing user interfaces and real-time data visualization.

docs/template/public/main.css

@@ -0,0 +1 @@
+@import "workflow.css";

docs/template/public/main.js

@@ -0,0 +1,13 @@
+import WorkflowContainer from "./workflow.js"
+
+export default {
+    defaultTheme: 'light',
+    iconLinks: [{
+        icon: 'github',
+        href: 'https://github.com/bonsai-rx/gui',
+        title: 'GitHub'
+    }],
+    start: () => {
+        WorkflowContainer.init();
+    }
+}

docs/toc.yml

@@ -0,0 +1,4 @@
+- name: Manual
+  href: articles/
+- name: Reference
+  href: api/