Add docfx docs infrastructure

open-ephys · May 24, 2024 · a52b583 · a52b583
1 parent 7b834e2
commit a52b583
Show file tree

Hide file tree

Showing 17 changed files with 822 additions and 0 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "docfx": {
+      "version": "2.75.3",
+      "commands": [
+        "docfx"
+      ]
+    }
+  }
+}
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+* text=auto
+*.ico binary
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,10 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_exported_templates
+_site
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,6 @@
+[submodule "docfx-tools"]
+	path = docfx-tools
+	url = https://github.com/bonsai-rx/docfx-tools
+[submodule "src/onix-refactor"]
+	path = src/onix-refactor
+	url = https://github.com/neurogears/onix-refactor.git
diff --git a/LICENSE b/LICENSE
diff --git a/api/.gitignore b/api/.gitignore
@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest
diff --git a/articles/introduction.md b/articles/introduction.md
@@ -0,0 +1 @@
+# Introduction
diff --git a/articles/toc.yml b/articles/toc.yml
@@ -0,0 +1,2 @@
+- href: ../index.md
+- href: introduction.md
diff --git a/docfx-tools b/docfx-tools
diff --git a/docfx.json b/docfx.json
@@ -0,0 +1,76 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "src/**.csproj"
+          ]
+        }
+      ],
+      "dest": "api",
+      "filter": "filter.yml"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**",
+          "docfx-tools/**",
+          "filter.yml"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "logo.svg",
+          "favicon.png",
+          "images/**",
+          "workflows/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "template": [
+      "default",
+      "modern",
+      "docfx-tools/template",
+      "template"
+    ],
+    "globalMetadata": {
+      "_enableNewTab": true,
+      "_enableSearch": true,
+      "pdf": false,
+      "_appFooter": "&copy; 2024 Open Ephys and Contributors. Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a>",
+      "_appFaviconPath": "favicon.png"
+    },
+    "markdownEngineName": "markdig",
+    "markdownEngineProperties": {
+      "markdigExtensions": [
+        "attributes",
+        "customcontainers"
+      ]
+    },
+    "xref": [
+      "https://bonsai-rx.org/docs/xrefmap.yml",
+      "https://horizongir.github.io/opencv.net/xrefmap.yml",
+      "https://horizongir.github.io/reactive/xrefmap.yml"
+    ]
+  }
+}
diff --git a/favicon.png b/favicon.png
diff --git a/filter.yml b/filter.yml
@@ -0,0 +1,4 @@
+apiRules:
+- exclude:
+    hasAttribute:
+      uid: System.ObsoleteAttribute
diff --git a/index.md b/index.md
@@ -0,0 +1,5 @@
+# Getting Started
+
+`OpenEphys.Onix` is a [Bonsai](https://bonsai-rx.org/) interface for [Open Neuro Interface](https://github.com/open-ephys/ONI)-compliant hardware. All device initialization, configuration, and streaming functionality is exposed via reactive operators.
+
+To install `OpenEphys.Onix` use the Bonsai package manager and search for the **OpenEphys.Onix** package.
diff --git a/logo.svg b/logo.svg
diff --git a/src/onix-refactor b/src/onix-refactor
diff --git a/toc.yml b/toc.yml
@@ -0,0 +1,4 @@
+- name: Software Guide
+  href: articles/
+- name: Technical Reference
+  href: api/
diff --git a/workflows/.gitignore b/workflows/.gitignore
@@ -0,0 +1,2 @@
+*.layout
+*.svg