diff --git a/README.md b/README.md index 528b343d0..5302a7591 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,10 @@ The simplest way to get started is to add the platform-specific NuGet package(s) The ArcGIS Runtime SDK Toolkit is provided as an open-source project so you can customize it for your requirements. [See the docs](https://esri.github.io/arcgis-toolkit-dotnet/buildingtoolkit.html) for instructions on building the Toolkit yourself. +## Compatibility + +Nuget packages for Toolkit are tested and published in sync with the `Esri.ArcGISRuntime.*` packages. Toolkit is only supported when used with the matching Runtime API version. + ## Contribute Anyone and everyone is welcome to [contribute](CONTRIBUTING.md). diff --git a/docs/BuildDoc.cmd b/docs/BuildDoc.cmd index 796fe1164..4491e7fe8 100644 --- a/docs/BuildDoc.cmd +++ b/docs/BuildDoc.cmd @@ -1,6 +1,6 @@ @ECHO OFF -SET DocFXVersion=2.58 +SET DocFXVersion=2.59.4 SET DocFxFolder=%~dp0..\.tools\docfx REM Download DocFx diff --git a/docs/api/index.md b/docs/api/index.md index f2a9643ad..de5a3c8f3 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -2,15 +2,8 @@ **Select your platform:** -- [.NET Standard API Reference](netstd/index.md) - -- [.NET Framework API Reference](netfx/index.md) - -- [.NET Core API Reference](netcore/index.md) - -- [UWP API Reference](uwp/index.md) - -- [Android API Reference](android/index.md) - -- [iOS API Reference](ios/index.md) - +- [.NET Framework (WPF)](netfx/index.md) +- [.NET 6 (WPF, WinUI, MAUI WinUI)](net6/index.html) +- [UWP](uwp/index.md) +- [MAUI Android](android/index.md) +- [MAUI iOS](ios/index.md) diff --git a/docs/api/netcore/index.md b/docs/api/net6/index.md similarity index 100% rename from docs/api/netcore/index.md rename to docs/api/net6/index.md diff --git a/docs/docfx.json b/docs/docfx.json index 138c2eccb..92f2ced7a 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -4,15 +4,14 @@ "src": [ { "files": [ - "Toolkit/Toolkit/Esri.ArcGISRuntime.Toolkit.csproj", - "Toolkit.Preview/Toolkit.Preview/Esri.ArcGISRuntime.Toolkit.Preview.csproj" + "Toolkit/Toolkit.WPF/Esri.ArcGISRuntime.Toolkit.WPF.csproj" ], "exclude": [ "**/bin/**", "**/obj/**" ], - "src" : "../src/", + "src" : "../src/" } ], "dest": "../output/docs/api/netfx", - "properties": { "TargetFramework": "net461" }, + "properties": { "TargetFramework": "net472" }, "disableGitFeatures": false, "disableDefaultFilter": false }, @@ -20,14 +19,16 @@ "src": [ { "files": [ - "Toolkit/Toolkit/Esri.ArcGISRuntime.Toolkit.csproj", - "Toolkit.Preview/Toolkit.Preview/Esri.ArcGISRuntime.Toolkit.Preview.csproj" ], + "Toolkit/Toolkit.WPF/Esri.ArcGISRuntime.Toolkit.WPF.csproj", + "Toolkit/Toolkit.WinUI/Esri.ArcGISRuntime.Toolkit.WinUI.csproj", + "Toolkit/Toolkit.Maui/Esri.ArcGISRuntime.Toolkit.Maui.csproj" + ], "exclude": [ "**/bin/**", "**/obj/**" ], - "src" : "../src/", + "src" : "../src/" } ], - "dest": "../output/docs/api/netcore", - "properties": { "TargetFramework": "netcoreapp3.1" }, + "dest": "../output/docs/api/net6", + "properties": { "TargetFramework": "net6.0-windows10.0.19041.0" }, "disableGitFeatures": false, "disableDefaultFilter": false }, @@ -35,18 +36,16 @@ "src": [ { "files": [ - "Toolkit/Toolkit/Esri.ArcGISRuntime.Toolkit.csproj", - "Toolkit.Forms/Esri.ArcGISRuntime.Toolkit.Xamarin.Forms.csproj", - "Toolkit.Preview/Toolkit.Preview/Esri.ArcGISRuntime.Toolkit.Preview.csproj", + "Toolkit/Toolkit.Maui/Esri.ArcGISRuntime.Toolkit.Maui.csproj", "ARToolkit/Esri.ArcGISRuntime.ARToolkit.csproj", - "ARToolkit.Forms/Esri.ArcGISRuntime.ARToolkit.Forms.csproj" + "ARToolkit.Maui/Esri.ArcGISRuntime.ARToolkit.Maui.csproj" ], "exclude": [ "**/bin/**", "**/obj/**" ], - "src" : "../src/", + "src" : "../src/" } ], "dest": "../output/docs/api/android", - "properties": { "TargetFramework": "monoandroid81" }, + "properties": { "TargetFramework": "net6.0-android" }, "filter": "filterConfig.yml", "disableGitFeatures": false, "disableDefaultFilter": false @@ -55,18 +54,16 @@ "src": [ { "files": [ - "Toolkit/Toolkit/Esri.ArcGISRuntime.Toolkit.csproj", - "Toolkit.Forms/Esri.ArcGISRuntime.Toolkit.Xamarin.Forms.csproj", - "Toolkit.Preview/Toolkit.Preview/Esri.ArcGISRuntime.Toolkit.Preview.csproj", + "Toolkit/Toolkit.Maui/Esri.ArcGISRuntime.Toolkit.Maui.csproj", "ARToolkit/Esri.ArcGISRuntime.ARToolkit.csproj", - "ARToolkit.Forms/Esri.ArcGISRuntime.ARToolkit.Forms.csproj" + "ARToolkit.Maui/Esri.ArcGISRuntime.ARToolkit.Maui.csproj" ], "exclude": [ "**/bin/**", "**/obj/**" ], - "src" : "../src/", + "src" : "../src/" } ], "dest": "../output/docs/api/ios", - "properties": { "TargetFramework": "xamarinios10" }, + "properties": { "TargetFramework": "net6.0-ios" }, "disableGitFeatures": false, "disableDefaultFilter": false }, @@ -74,38 +71,17 @@ "src": [ { "files": [ - "Toolkit/Toolkit/Esri.ArcGISRuntime.Toolkit.csproj", - "Toolkit.Forms/Esri.ArcGISRuntime.Toolkit.Xamarin.Forms.csproj", - "Toolkit.Preview/Toolkit.Preview/Esri.ArcGISRuntime.Toolkit.Preview.csproj" + "Toolkit/Toolkit.UWP/Esri.ArcGISRuntime.Toolkit.UWP.csproj" ], "exclude": [ "**/bin/**", "**/obj/**" ], "src" : "../src/", } ], "dest": "../output/docs/api/uwp", - "properties": { "TargetFramework": "uap10.0.16299" }, + "properties": { "TargetFramework": "uap10.0.19041" }, "filter": "filterConfig.yml", "disableGitFeatures": false, "disableDefaultFilter": false - }, - { - "src": [ - { - "files": [ - "Toolkit/Toolkit/Esri.ArcGISRuntime.Toolkit.csproj", - "Toolkit.Forms/Esri.ArcGISRuntime.Toolkit.Xamarin.Forms.csproj", - "Toolkit.Preview/Toolkit.Preview/Esri.ArcGISRuntime.Toolkit.Preview.csproj", - "ARToolkit/Esri.ArcGISRuntime.ARToolkit.csproj", - "ARToolkit.Forms/Esri.ArcGISRuntime.ARToolkit.Forms.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src" : "../src/", - } - ], - "dest": "../output/docs/api/netstd", - "properties": { "TargetFramework": "netstandard2.0" }, - "disableGitFeatures": false, - "disableDefaultFilter": false } ], "build": {