From 0cd5391d6e0d20a44f72c834e621a753a6eb23b4 Mon Sep 17 00:00:00 2001 From: Julien Kipp Date: Fri, 22 Dec 2023 15:58:23 +0100 Subject: [PATCH] make sure docs build correctly on CI no UnityEngine references though :( --- docs/docfx.json | 6 +++--- docs/filterConfig.yml | 6 +++++- docs/manual/getting-started.md | 2 +- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/docfx.json b/docs/docfx.json index c1ed3c2..af91303 100644 --- 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 index dd1aaba..8b39213 100644 --- a/docs/filterConfig.yml +++ b/docs/filterConfig.yml @@ -4,4 +4,8 @@ apiRules: type: Namespace - include: uidRegex: ^Global - type: Namespace \ No newline at end of file + type: Namespace +- exclude: + uidRegex: ^Midas\.Editor +- exclude: + uidRegex: ^Midas\.Samples \ No newline at end of file diff --git a/docs/manual/getting-started.md b/docs/manual/getting-started.md index 537ab1c..88aa43a 100644 --- 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