Skip to content

Commit

Permalink
v200 doc updates (#463)
Browse files Browse the repository at this point in the history
* Add compatibility note to readme

Addresses #322

* Update docfx for v200
  • Loading branch information
nCastle1 committed Nov 7, 2022
1 parent 405a18f commit 962870a
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 57 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion docs/BuildDoc.cmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
@ECHO OFF

SET DocFXVersion=2.58
SET DocFXVersion=2.59.4
SET DocFxFolder=%~dp0..\.tools\docfx

REM Download DocFx
Expand Down
17 changes: 5 additions & 12 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
File renamed without changes.
64 changes: 20 additions & 44 deletions docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,49 +4,48 @@
"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
},
{
"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
},
{
"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
Expand All @@ -55,57 +54,34 @@
"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
},
{
"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": {
Expand Down

0 comments on commit 962870a

Please sign in to comment.