added docfx

Jani Giannoudis · Jani Giannoudis · commit 7b124257696b · 2023-07-22T08:47:44.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -338,3 +338,9 @@ ASALocalRun/
 
 /NDependOut*
 
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
diff --git a/docfx/.gitignore b/docfx/.gitignore
@@ -0,0 +1,9 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+
diff --git a/docfx/Browse.cmd b/docfx/Browse.cmd
@@ -0,0 +1,2 @@
+@echo off
+start "" %~dp0_site/index.html
diff --git a/docfx/Build.cmd b/docfx/Build.cmd
@@ -0,0 +1,2 @@
+@echo off
+call docfx
diff --git a/docfx/api/.gitignore b/docfx/api/.gitignore
@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest
diff --git a/docfx/api/index.md b/docfx/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/docfx/articles/intro.md b/docfx/articles/intro.md
@@ -0,0 +1 @@
+# Add your introductions here!
diff --git a/docfx/articles/toc.yml b/docfx/articles/toc.yml
@@ -0,0 +1,2 @@
+- name: Introduction
+  href: intro.md
diff --git a/docfx/docfx.json b/docfx/docfx.json
@@ -0,0 +1,55 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [ "/**.csproj" ],
+          "src": "../Client.Scripting/"
+        }
+      ],
+      "dest": "api",
+      "includePrivateMembers": false,
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "noRestore": false,
+      "namespaceLayout": "flattened",
+      "memberLayout": "samePage",
+      "allowCompilationErrors": false,
+      "filter": "filterConfig.yml"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "articles/**.md",
+          "articles/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "statictoc"
+    ],
+    "postProcessors": [],
+    "keepFileLink": false,
+    "disableGitFeatures": false
+  }
+}
diff --git a/docfx/filterConfig.yml b/docfx/filterConfig.yml
@@ -0,0 +1,20 @@
+apiRules:
+- exclude:
+    uidRegex: ^PayrollEngine.Client.Scripting\.Runtime
+    type: Type
+- exclude:
+    uidRegex: ^PayrollEngine.Client.Scripting\.Script
+    type: Type
+- exclude:
+    uidRegex: ^PayrollEngine.Client.Scripting\.Cache
+    type: Type
+- exclude:
+    uidRegex: ^$FunctionAttribute
+    type: Type
+- exclude:
+    uidRegex: ^$ScriptAttribute
+    type: Type
+- exclude:
+    uidRegex: ^SystemActionProvider
+    type: Type
+
diff --git a/docfx/index.md b/docfx/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/docfx/toc.yml b/docfx/toc.yml
@@ -0,0 +1,5 @@
+- name: Articles
+  href: articles/
+- name: Api Documentation
+  href: api/
+  homepage: api/index.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+@echo off`
	`2`	`+start "" %~dp0_site/index.html`
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`