Added API documentation to DocFX

Removed subfolder mapsui from DocFX Changed build-site.cmd because of new folder structure
ahopper · Jun 13, 2018 · 1de5426 · 1de5426
1 parent 938b5db
commit 1de5426
Show file tree

Hide file tree

Showing 32 changed files with 126 additions and 105 deletions.
diff --git a/Mapsui.sln b/Mapsui.sln
@@ -92,35 +92,46 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docfx", "docfx", "{97458DE1-C297-4DED-AECB-5FEFED2B5610}"
 	ProjectSection(SolutionItems) = preProject
 		docfx\build-site.cmd = docfx\build-site.cmd
+		docfx\docfx.json = docfx\docfx.json
+		docfx\index.md = docfx\index.md
+		docfx\metadata.json = docfx\metadata.json
+		docfx\toc.yml = docfx\toc.yml
 	EndProjectSection
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "mapsui", "mapsui", "{F9644AFA-4A28-42D3-AC64-4718D037CC59}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "documentation", "documentation", "{7D976D37-0542-4A0D-99E6-6BAA180E7011}"
+	ProjectSection(SolutionItems) = preProject
+		docfx\documentation\Async-Fetching.md = docfx\documentation\Async-Fetching.md
+		docfx\documentation\Contributors-Guidelines.md = docfx\documentation\Contributors-Guidelines.md
+		docfx\documentation\Development-constraints.md = docfx\documentation\Development-constraints.md
+		docfx\documentation\documentation.md = docfx\documentation\documentation.md
+		docfx\documentation\getting-started-android.md = docfx\documentation\getting-started-android.md
+		docfx\documentation\getting-started-wpf.md = docfx\documentation\getting-started-wpf.md
+		docfx\documentation\Home.md = docfx\documentation\Home.md
+		docfx\documentation\How-to-work-with-Mapsui.md = docfx\documentation\How-to-work-with-Mapsui.md
+		docfx\documentation\Mapsui-2.0.md = docfx\documentation\Mapsui-2.0.md
+		docfx\documentation\Mapsui-Components.md = docfx\documentation\Mapsui-Components.md
+		docfx\documentation\NuGet-of-latest-build.md = docfx\documentation\NuGet-of-latest-build.md
+		docfx\documentation\Renderers.md = docfx\documentation\Renderers.md
+		docfx\documentation\Rendering-Tests.md = docfx\documentation\Rendering-Tests.md
+		docfx\documentation\Roadmap.md = docfx\documentation\Roadmap.md
+		docfx\documentation\samples.md = docfx\documentation\samples.md
+		docfx\documentation\skia-scale.md = docfx\documentation\skia-scale.md
+		docfx\documentation\toc.md = docfx\documentation\toc.md
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "images", "images", "{52C84C7C-1D60-454E-804A-1F9691BD61A3}"
+	ProjectSection(SolutionItems) = preProject
+		docfx\documentation\images\brutile_fetcher.png = docfx\documentation\images\brutile_fetcher.png
+	EndProjectSection
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "documentation", "documentation", "{6F159183-6CC2-4D97-A0D6-55FC6F630FD5}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "api", "api", "{5BB9C8BA-0FF4-40E7-BC36-8D671A951C82}"
 	ProjectSection(SolutionItems) = preProject
-		docfx\mapsui\documentation\Async-Fetching.md = docfx\mapsui\documentation\Async-Fetching.md
-		docfx\mapsui\documentation\Contributors-Guidelines.md = docfx\mapsui\documentation\Contributors-Guidelines.md
-		docfx\mapsui\documentation\Development-constraints.md = docfx\mapsui\documentation\Development-constraints.md
-		docfx\mapsui\documentation\documentation.md = docfx\mapsui\documentation\documentation.md
-		docfx\mapsui\documentation\getting-started-android.md = docfx\mapsui\documentation\getting-started-android.md
-		docfx\mapsui\documentation\getting-started-wpf.md = docfx\mapsui\documentation\getting-started-wpf.md
-		docfx\mapsui\documentation\Home.md = docfx\mapsui\documentation\Home.md
-		docfx\mapsui\documentation\How-to-work-with-Mapsui.md = docfx\mapsui\documentation\How-to-work-with-Mapsui.md
-		docfx\mapsui\documentation\Mapsui-2.0.md = docfx\mapsui\documentation\Mapsui-2.0.md
-		docfx\mapsui\documentation\Mapsui-Components.md = docfx\mapsui\documentation\Mapsui-Components.md
-		docfx\mapsui\documentation\NuGet-of-latest-build.md = docfx\mapsui\documentation\NuGet-of-latest-build.md
-		docfx\mapsui\documentation\Renderers.md = docfx\mapsui\documentation\Renderers.md
-		docfx\mapsui\documentation\Rendering-Tests.md = docfx\mapsui\documentation\Rendering-Tests.md
-		docfx\mapsui\documentation\Roadmap.md = docfx\mapsui\documentation\Roadmap.md
-		docfx\mapsui\documentation\samples.md = docfx\mapsui\documentation\samples.md
-		docfx\mapsui\documentation\skia-scale.md = docfx\mapsui\documentation\skia-scale.md
-		docfx\mapsui\documentation\toc.md = docfx\mapsui\documentation\toc.md
+		docfx\api\index.md = docfx\api\index.md
 	EndProjectSection
 EndProject
 Global
 	GlobalSection(SharedMSBuildProjectFiles) = preSolution
 		Mapsui.UI.Shared\Mapsui.UI.Shared.projitems*{239f2b0d-13cb-4bcf-83bf-f52d696a47b7}*SharedItemsImports = 13
-		Mapsui.UI.Shared\Mapsui.UI.Shared.projitems*{29e628d1-8e8a-49c5-b0f9-555c0f68572a}*SharedItemsImports = 4
 		Mapsui.UI.Shared\Mapsui.UI.Shared.projitems*{a9ed0aa7-b6f0-4946-8a08-7c531e5cfa9b}*SharedItemsImports = 4
 		Mapsui.UI.Shared\Mapsui.UI.Shared.projitems*{ae693902-feda-4034-a7c5-9aa9872f7878}*SharedItemsImports = 4
 		Mapsui.UI.Shared\Mapsui.UI.Shared.projitems*{e71f3053-056c-4381-9638-048ed73bdff6}*SharedItemsImports = 4
@@ -537,8 +548,9 @@ Global
 		{A6D5A694-454C-432B-BB24-AB784876E8E1} = {CB6BE9F9-5ECF-471B-9D93-605E2BD6825D}
 		{CA0C7AF3-03ED-42D0-A001-001E8EE095E6} = {969DB691-49FB-4785-98F4-2112CC1BA7C4}
 		{16D71D4F-1D3F-483E-9C6C-A3A25B6A20A9} = {969DB691-49FB-4785-98F4-2112CC1BA7C4}
-		{F9644AFA-4A28-42D3-AC64-4718D037CC59} = {97458DE1-C297-4DED-AECB-5FEFED2B5610}
-		{6F159183-6CC2-4D97-A0D6-55FC6F630FD5} = {F9644AFA-4A28-42D3-AC64-4718D037CC59}
+		{7D976D37-0542-4A0D-99E6-6BAA180E7011} = {97458DE1-C297-4DED-AECB-5FEFED2B5610}
+		{52C84C7C-1D60-454E-804A-1F9691BD61A3} = {7D976D37-0542-4A0D-99E6-6BAA180E7011}
+		{5BB9C8BA-0FF4-40E7-BC36-8D671A951C82} = {97458DE1-C297-4DED-AECB-5FEFED2B5610}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {22D684C3-0BD3-4D8A-AB23-748FB5527F6F}

diff --git a/docfx/mapsui/.gitignore → docfx/.gitignore b/docfx/mapsui/.gitignore → docfx/.gitignore
@@ -6,4 +6,6 @@
 /**/packages/
 /**/bin/
 /**/obj/
+api/*.yml
+api/.manifest
 _site
diff --git a/docfx/api/index.md b/docfx/api/index.md
@@ -0,0 +1,2 @@
+# Mapsui API
+This is the API description of Mapsui
diff --git a/docfx/build-site.cmd b/docfx/build-site.cmd
@@ -1,5 +1,5 @@
 choco install docfx -y
 choco update docfx -y
-docfx docfx\mapsui\docfx.json
+docfx docfx\docfx.json
 del docs /s /q 
-xcopy docfx\mapsui\_site docs /E /Y
+xcopy docfx\_site docs /E /Y
diff --git a/docfx/docfx.json b/docfx/docfx.json
@@ -0,0 +1,85 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "cwd": "../",
+          "files": [
+            "Mapsui/*.csproj",
+            "Mapsui.Geometries/*.csproj",
+            "Mapsui.Rendering.Skia/*.csproj",
+            "Mapsui.Rendering.Xaml/*.csproj",
+            "Mapsui.UI.Uwp/*.csproj",
+            "Mapsui.UI.Wpf/*.csproj",
+            "Mapsui.UI.iOS/*.csproj",
+            "Mapsui.UI.Android/*.csproj",
+            "Mapsui.Desktop/*.csproj"
+          ],
+          "exclude": [
+            "**/obj/**",
+            "**/bin/**",
+            "_site/**"
+          ]
+        }
+      ],
+      "dest": "api",
+      "disableGitFeatures": false,
+      "properties": {
+        "TargetFramework": "netstandard2.0"
+      }
+    }
+  ],
+  "build": {
+        "content": [
+          {
+            "files": [
+              "api/**.yml",
+              "api/index.md",
+              "documentation/**.md",
+              "documentation/**/toc.md",
+              "documentation/**.png",
+              "toc.yml",
+              "*.md"
+            ],
+            "exclude": [
+              "obj/**",
+              "_site/**"
+            ]
+          }
+        ],
+        "resource": [
+          {
+            "files": [
+              "images/**",
+              "documentation/images/**"
+            ],
+            "exclude": [
+              "obj/**",
+              "_site/**"
+            ]
+          }
+        ],
+        "overwrite": [
+          {
+            "files": [
+              "apidoc/**.md"
+            ],
+            "exclude": [
+              "obj/**",
+              "_site/**"
+            ]
+          }
+        ],
+        "dest": "_site",
+        "globalMetadataFiles": [ "metadata.json" ],
+        "fileMetadataFiles": [],
+        "template": [
+          "default"
+        ],
+        "postProcessors": [],
+        "noLangKeyword": false,
+        "keepFileLink": false,
+        "cleanupCacheHistory": false,
+        "disableGitFeatures": false
+      }
+    }
diff --git a/docfx/mapsui/documentation/Async-Fetching.md → docfx/documentation/Async-Fetching.md b/docfx/mapsui/documentation/Async-Fetching.md → docfx/documentation/Async-Fetching.md
diff --git a/.../documentation/Contributors-Guidelines.md → .../documentation/Contributors-Guidelines.md b/.../documentation/Contributors-Guidelines.md → .../documentation/Contributors-Guidelines.md
diff --git a/.../documentation/Development-constraints.md → .../documentation/Development-constraints.md b/.../documentation/Development-constraints.md → .../documentation/Development-constraints.md
diff --git a/docfx/mapsui/documentation/Home.md → docfx/documentation/Home.md b/docfx/mapsui/documentation/Home.md → docfx/documentation/Home.md
diff --git a/.../documentation/How-to-work-with-Mapsui.md → .../documentation/How-to-work-with-Mapsui.md b/.../documentation/How-to-work-with-Mapsui.md → .../documentation/How-to-work-with-Mapsui.md
diff --git a/docfx/mapsui/documentation/Mapsui-2.0.md → docfx/documentation/Mapsui-2.0.md b/docfx/mapsui/documentation/Mapsui-2.0.md → docfx/documentation/Mapsui-2.0.md
diff --git a/...mapsui/documentation/Mapsui-Components.md → docfx/documentation/Mapsui-Components.md b/...mapsui/documentation/Mapsui-Components.md → docfx/documentation/Mapsui-Components.md
diff --git a/...ui/documentation/NuGet-of-latest-build.md → docfx/documentation/NuGet-of-latest-build.md b/...ui/documentation/NuGet-of-latest-build.md → docfx/documentation/NuGet-of-latest-build.md
diff --git a/docfx/mapsui/documentation/Renderers.md → docfx/documentation/Renderers.md b/docfx/mapsui/documentation/Renderers.md → docfx/documentation/Renderers.md
diff --git a/...x/mapsui/documentation/Rendering-Tests.md → docfx/documentation/Rendering-Tests.md b/...x/mapsui/documentation/Rendering-Tests.md → docfx/documentation/Rendering-Tests.md
diff --git a/docfx/mapsui/documentation/Roadmap.md → docfx/documentation/Roadmap.md b/docfx/mapsui/documentation/Roadmap.md → docfx/documentation/Roadmap.md
diff --git a/docfx/mapsui/documentation/documentation.md → docfx/documentation/documentation.md b/docfx/mapsui/documentation/documentation.md → docfx/documentation/documentation.md
diff --git a/.../documentation/getting-started-android.md → .../documentation/getting-started-android.md b/.../documentation/getting-started-android.md → .../documentation/getting-started-android.md
diff --git a/...psui/documentation/getting-started-wpf.md → docfx/documentation/getting-started-wpf.md b/...psui/documentation/getting-started-wpf.md → docfx/documentation/getting-started-wpf.md
diff --git a/.../documentation/images/brutile_fetcher.png → .../documentation/images/brutile_fetcher.png b/.../documentation/images/brutile_fetcher.png → .../documentation/images/brutile_fetcher.png
diff --git a/docfx/mapsui/documentation/samples.md → docfx/documentation/samples.md b/docfx/mapsui/documentation/samples.md → docfx/documentation/samples.md
diff --git a/docfx/mapsui/documentation/skia-scale.md → docfx/documentation/skia-scale.md b/docfx/mapsui/documentation/skia-scale.md → docfx/documentation/skia-scale.md
diff --git a/docfx/mapsui/documentation/toc.md → docfx/documentation/toc.md b/docfx/mapsui/documentation/toc.md → docfx/documentation/toc.md
diff --git a/docfx/mapsui/images/brutile_fetcher.png → docfx/images/brutile_fetcher.png b/docfx/mapsui/images/brutile_fetcher.png → docfx/images/brutile_fetcher.png
diff --git a/docfx/mapsui/images/favicon.ico → docfx/images/favicon.ico b/docfx/mapsui/images/favicon.ico → docfx/images/favicon.ico
diff --git a/docfx/mapsui/images/logo.svg → docfx/images/logo.svg b/docfx/mapsui/images/logo.svg → docfx/images/logo.svg
diff --git a/docfx/mapsui/index.md → docfx/index.md b/docfx/mapsui/index.md → docfx/index.md
diff --git a/docfx/mapsui/api/.gitignore b/docfx/mapsui/api/.gitignore
diff --git a/docfx/mapsui/api/index.md b/docfx/mapsui/api/index.md
diff --git a/docfx/mapsui/docfx.json b/docfx/mapsui/docfx.json
diff --git a/docfx/mapsui/metadata.json → docfx/metadata.json b/docfx/mapsui/metadata.json → docfx/metadata.json
diff --git a/docfx/mapsui/toc.yml → docfx/toc.yml b/docfx/mapsui/toc.yml → docfx/toc.yml
@@ -1,5 +1,5 @@
 - name: Documentation
   href: documentation/
-- name: Mapsui Api
+- name: API
   href: api/
   homepage: api/index.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Mapsui API
		This is the API description of Mapsui