[dotnet] Generate API documentation (#11968)

nvborisenko · diemol · web-flow · commit 55283eb79ba7 · 2023-05-06T00:14:48.000+02:00
Co-authored-by: Diego Molina &lt;diemol@users.noreply.github.com&gt;
diff --git a/dotnet/docs/.gitignore b/dotnet/docs/.gitignore
@@ -0,0 +1,9 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
diff --git a/dotnet/docs/api/.gitignore b/dotnet/docs/api/.gitignore
@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest
diff --git a/dotnet/docs/api/index.md b/dotnet/docs/api/index.md
@@ -0,0 +1,2 @@
+# PLACEHOLDER
+TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
diff --git a/dotnet/docs/articles/intro.md b/dotnet/docs/articles/intro.md
@@ -0,0 +1 @@
+# Add your introductions here!
diff --git a/dotnet/docs/articles/toc.yml b/dotnet/docs/articles/toc.yml
@@ -0,0 +1,2 @@
+- name: Introduction
+  href: intro.md
diff --git a/dotnet/docs/build.desc b/dotnet/docs/build.desc
diff --git a/dotnet/docs/docfx.json b/dotnet/docs/docfx.json
@@ -0,0 +1,58 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "src/webdriver/WebDriver.csproj",
+            "bin/**/*.dll"
+          ],
+          "src": "../"
+        }
+      ],
+      "dest": "api",
+      "includePrivateMembers": false,
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "noRestore": false,
+      "namespaceLayout": "flattened",
+      "memberLayout": "samePage",
+      "allowCompilationErrors": false
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "articles/**.md",
+          "articles/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "dest": "../../build/docs/api/dotnet",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default",
+      "modern"
+    ],
+    "postProcessors": [],
+    "keepFileLink": false,
+    "disableGitFeatures": false
+  }
+}
diff --git a/dotnet/docs/docs.shfbproj b/dotnet/docs/docs.shfbproj
diff --git a/dotnet/docs/index.md b/dotnet/docs/index.md
@@ -0,0 +1,4 @@
+# This is the **HOMEPAGE**.
+Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
+## Quick Start Notes:
+1. Add images to the *images* folder if the file is referencing an image.
diff --git a/dotnet/docs/toc.yml b/dotnet/docs/toc.yml
@@ -0,0 +1,5 @@
+- name: Articles
+  href: articles/
+- name: Api Documentation
+  href: api/
+  homepage: api/index.md
diff --git a/generate_api_docs.sh b/generate_api_docs.sh
@@ -13,6 +13,12 @@ rb)
   bazel run //rb:docs || exit
   docs="$(bazel cquery --output=files //rb:docs 2> /dev/null).runfiles/selenium/docs/api/rb"
   ;;
+dotnet)
+  # dotnet sdk should be installed
+  # bazel should be installed
+  dotnet tool update -g docfx
+  docfx dotnet/docs/docfx.json
+  ;;
 *)
   echo "Selenium API docs generation"
   echo "ERROR: unknown parameter \"$API_DOCS_LANGUAGE\""
@@ -44,6 +50,10 @@ rb)
   rm -rf docs/api/rb
   mv $docs docs/api/rb
   ;;
+dotnet)
+  rm -rf docs/api/dotnet
+  mv build/docs/api/dotnet docs/api/dotnet
+  ;;
 *)
   echo "ERROR: unknown parameter \"$API_DOCS_LANGUAGE\""
   exit 1

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# PLACEHOLDER`
	`2`	+TODO: Add .NET projects to the src folder and run `docfx` to generate REAL API Documentation!
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+- name: Introduction`
	`2`	`+ href: intro.md`