[dotnet] Fix API docs static generation (#14651)

* Fix it * Simplify * Logo * As api pages * Nested namespaces * Update toc.yml --------- Co-authored-by: Diego Molina <[email protected]>
SeleniumHQ · Nov 5, 2024 · c5cf658 · c5cf658
1 parent 3394215
commit c5cf658
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 22 deletions.
diff --git a/dotnet/docs/api/index.md b/dotnet/docs/api/index.md
diff --git a/dotnet/docs/docfx.json b/dotnet/docs/docfx.json
@@ -3,29 +3,40 @@
     {
       "src": [
         {
+          "src": "../src/webdriver",
           "files": [
-            "src/webdriver/WebDriver.csproj",
-            "src/support/WebDriver.Support.csproj",
-            "bin/**/*.dll"
-          ],
-          "src": "../"
+            "**/*.csproj"
+          ]
         }
       ],
-      "dest": "api",
-      "includePrivateMembers": false,
-      "disableGitFeatures": false,
-      "disableDefaultFilter": false,
-      "noRestore": false,
-      "namespaceLayout": "flattened",
-      "memberLayout": "samePage",
-      "allowCompilationErrors": false
+      "dest": "webdriver",
+      "namespaceLayout": "nested",
+      "outputFormat": "apiPage"
+    },
+    {
+      "src": [
+        {
+          "src": "../src/support",
+          "files": [
+            "**/*.csproj"
+          ]
+        }
+      ],
+      "dest": "support",
+      "namespaceLayout": "nested",
+      "outputFormat": "apiPage"
     }
+
   ],
   "build": {
     "content": [
       {
-        "files": "**/*.{md|yml}",
-        "src": "api"
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**"
+        ]
       }
     ],
     "resource": [
@@ -35,15 +46,16 @@
         ]
       }
     ],
-    "dest": "../../build/docs/api/dotnet",
-    "globalMetadataFiles": [],
-    "fileMetadataFiles": [],
+    "output": "../../build/docs/api/dotnet",
     "template": [
       "default",
       "modern"
     ],
-    "postProcessors": [],
-    "keepFileLink": false,
-    "disableGitFeatures": false
+    "globalMetadata": {
+      "_appName": "Selenium .NET API",
+      "_appLogoPath": "images/logo.svg",
+      "_appFaviconPath": "images/favicon.ico",
+      "_enableSearch": true
+    }
   }
 }
diff --git a/dotnet/docs/images/favicon.ico b/dotnet/docs/images/favicon.ico
diff --git a/dotnet/docs/images/logo.svg b/dotnet/docs/images/logo.svg
diff --git a/dotnet/docs/index.md b/dotnet/docs/index.md
@@ -0,0 +1,9 @@
+---
+layout: landingPage
+---
+
+# Welcome to the Selenium .NET API Docs
+
+## Modules
+- [Selenium.WebDriver](/webdriver/OpenQA.Selenium.html)
+- [Selenium.Support](/support/OpenQA.Selenium.Support.html)
diff --git a/dotnet/docs/api/.gitignore → dotnet/docs/support/.gitignore b/dotnet/docs/api/.gitignore → dotnet/docs/support/.gitignore
diff --git a/dotnet/docs/toc.yml b/dotnet/docs/toc.yml
@@ -0,0 +1,9 @@
+- name: Intro
+  href: index.md
+
+- name: Modules
+  items:
+  - name: WebDriver
+    href: webdriver/OpenQA.Selenium.yml
+  - name: Support
+    href: support/OpenQA.Selenium.Support.yml
diff --git a/dotnet/docs/webdriver/.gitignore b/dotnet/docs/webdriver/.gitignore
@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest