make sure docs build correctly on CI

no UnityEngine references though :(
julienkay · Dec 22, 2023 · 0cd5391 · 0cd5391
1 parent 94540bc
commit 0cd5391
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -4,9 +4,9 @@
       "src": [
         {
           "files": [
-            "doji.midas.csproj"
+            "**/*.cs"
           ],
-          "src": "../projects/Midas"
+          "src": "../com.doji.midas"
         }
       ],
       "dest": "api",
@@ -17,7 +17,7 @@
       "namespaceLayout": "flattened",
       "memberLayout": "samePage",
       "EnumSortOrder": "declaringOrder",
-      "allowCompilationErrors": false,
+      "allowCompilationErrors": true,
       "globalNamespaceId": "Global",
       "filter": "filterConfig.yml"
     }

diff --git a/docs/filterConfig.yml b/docs/filterConfig.yml
@@ -4,4 +4,8 @@ apiRules:
     type: Namespace
 - include:
     uidRegex: ^Global
-    type: Namespace
+    type: Namespace
+- exclude:
+    uidRegex: ^Midas\.Editor
+- exclude:
+    uidRegex: ^Midas\.Samples
diff --git a/docs/manual/getting-started.md b/docs/manual/getting-started.md
@@ -11,7 +11,7 @@ To start, create a new 'Midas' instance:
 var midas = new Midas();
 ```
 
-Then you can pass in a Texture2D to @Midas.Midas.EstimateDepth(UnityEngine.Texture,System.Boolean)
+Then you can pass in a Texture2D to @Midas.Midas.EstimateDepth(Texture,System.Boolean)
 
 ```CSharp
 // Estimate depth from an input texture