Merge pull request #1135 from shimat/docfx

DocFX
shimat · Dec 30, 2020 · 7721686 · 7721686
2 parents bab5808 + 7002403
commit 7721686
Show file tree

Hide file tree

Showing 18 changed files with 128 additions and 288 deletions.
diff --git a/.github/workflows/docfx.yml b/.github/workflows/docfx.yml
@@ -0,0 +1,35 @@
+name: DocFX
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+
+    runs-on: windows-2019
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+
+      - name: DocFX
+        shell: cmd
+        run: |
+          choco install docfx -y
+          docfx docfx\docfx.json
+
+      - name: Upload DocFX packages
+        uses: actions/upload-artifact@v2
+        with:
+          name: docfx_site
+          path: ${{ github.workspace }}\docfx\_site
+
+      - name: Publish Documentation on GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GH_PAT }}
+          publish_dir: docfx/_site
diff --git a/.github/workflows/docker-ubuntu18.yml b/.github/workflows/docker-ubuntu18.yml
diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml
@@ -118,8 +118,8 @@ jobs:
           dotnet test -c Release -f net48 --runtime win-x64
           cd ${env:GITHUB_WORKSPACE}
 
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v1
+      - name: Upload NuGet packages
+        uses: actions/upload-artifact@v2
         with:
-          name: artifacts_windows
+          name: nuget_packages_windows
           path: ${{ github.workspace }}\artifacts
diff --git a/doc/Content/VersionHistory/VersionHistory.aml b/doc/Content/VersionHistory/VersionHistory.aml
diff --git a/doc/Content/VersionHistory/v1.0.0.0.aml b/doc/Content/VersionHistory/v1.0.0.0.aml
diff --git a/doc/Content/Welcome.aml b/doc/Content/Welcome.aml
diff --git a/doc/ContentLayout.content b/doc/ContentLayout.content
diff --git a/doc/OpenCvSharpDocument.shfbproj b/doc/OpenCvSharpDocument.shfbproj
diff --git a/doc/OpenCvSharpDocument.sln b/doc/OpenCvSharpDocument.sln
diff --git a/doc/icons/Help.png b/doc/icons/Help.png
diff --git a/docfx/.gitignore b/docfx/.gitignore
@@ -0,0 +1,9 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
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 @@
+# **[OpenCvSharp](https://github.com/shimat/opencvsharp) API Reference**
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