Fix Documentation build (#677)

* Fix Documentation build

* Update docs/docfx.json

Co-authored-by: Prathamesh Narkhede <[email protected]>

* Apply suggestions from code review

Co-authored-by: Prathamesh Narkhede <[email protected]>

* Fix toolkit repo urls

---------

Co-authored-by: Morten Nielsen <[email protected]>
Co-authored-by: Prathamesh Narkhede <[email protected]>

Author: 3 people

.github/workflows/ghpages.yml

@@ -23,6 +23,11 @@ jobs:
       env:
         DOCFXVERSION: 2.59.4
 
+    - name: Download .NET xrefmap
+      run: |
+        mkdir output
+        Invoke-WebRequest -Uri "https://github.com/dotnet/docfx/raw/main/.xrefmap.json" -OutFile "output/dotnet.xrefmap.json"
+
     - name: Build Documentation
       env:         
         DOCFX_SOURCE_BRANCH_NAME: main

docs/BuildDoc.cmd

@@ -11,6 +11,10 @@ IF NOT EXIST "%DocFxFolder%\v%DocFXVersion%\docfx.exe" (
    powershell -ExecutionPolicy ByPass -command "Expand-Archive -LiteralPath '%DocFxFolder%\docfx_v%DocFXVersion%.zip' -DestinationPath '%DocFxFolder%\v%DocFXVersion%'"
    DEL "%DocFxFolder%\docfx_v%DocFXVersion%.zip" /Q
 )
+IF NOT EXIST "../Output/dotnet.xrefmap.json" (
+   powershell -ExecutionPolicy ByPass -command "Invoke-WebRequest -Uri "https://github.com/dotnet/docfx/raw/main/.xrefmap.json" -OutFile '../Output/dotnet.xrefmap.json'"
+)
+
 REM Build the output site (HTML) from the generated metadata and input files (uses configuration in docfx.json in this folder)
 %DocFxFolder%\v%DocFXVersion%\docfx.exe %~dp0\docfx.json
 ECHO Fixing API Reference Links
@@ -23,4 +27,4 @@ REM cd %~dp0..\Output\docs_site
 REM git init
 REM git add .
 REM git commit -m "Update doc"
-REM git push --force https://github.com/Esri/arcgis-toolkit-dotnet.git main:gh-pages
+REM git push --force https://github.com/Esri/arcgis-maps-sdk-dotnet-toolkit.git main:gh-pages

docs/FixApiRefLinks.ps1

@@ -7,7 +7,7 @@ function FixApiLinks([string]$path)
     foreach ($file in $files)
     {
         $content = Get-Content -Path $file
-        $newContent = $content -replace "../(android|ios|uwp|netcore|netstd|netfx)/", ''
+        $newContent = $content -replace "../(android|ios|uwp|netwin|netstd|netfx)/", ''
         $newContent | Set-Content -Path $file
     }
 }

docs/api/index.md

@@ -3,7 +3,7 @@
 **Select your platform:**
 
 - [.NET Framework (WPF)](netfx/index.md)
-- [.NET 6 (WPF, WinUI, MAUI WinUI)](net6/index.html)
+- [.NET Windows (WPF, WinUI, MAUI WinUI)](netwin/index.md)
 - [UWP](uwp/index.md)
 - [MAUI Android](android/index.md)
 - [MAUI iOS](ios/index.md)

docs/api/net6/index.md renamed to docs/api/netwin/index.md

@@ -27,8 +27,8 @@
           "src" : "../src/"
         }
       ],
-      "dest": "../output/docs/api/net6",
-      "properties": { "TargetFramework": "net6.0-windows10.0.19041.0" },
+      "dest": "../Output/docs/api/netwin",
+      "properties": { "TargetFramework": "net9.0-windows10.0.19041.0" },
       "disableGitFeatures": false,
       "disableDefaultFilter": false
     },
@@ -44,8 +44,8 @@
           "src" : "../src/"
         }
       ],
-      "dest": "../output/docs/api/android",
-      "properties": { "TargetFramework": "net6.0-android" },
+      "dest": "../Output/docs/api/android",
+      "properties": { "TargetFramework": "net9.0-android" },
       "filter": "filterConfig.yml",
       "disableGitFeatures": false,
       "disableDefaultFilter": false
@@ -62,8 +62,8 @@
           "src" : "../src/"
         }
       ],
-      "dest": "../output/docs/api/ios",
-      "properties": { "TargetFramework": "net6.0-ios" },
+      "dest": "../Output/docs/api/ios",
+      "properties": { "TargetFramework": "net9.0-ios" },
       "disableGitFeatures": false,
       "disableDefaultFilter": false
     },
@@ -125,7 +125,7 @@
       "_appLogoPath": "images/logo.png",
       "_gitContribute": {
         "branch": "main",
-        "apiSpecFolder": "docs/apidoc"
+        "apiSpecFolder": "docs/api"
       }
     },
     "dest": "../Output/docs_site",
@@ -134,14 +134,15 @@
     "template": [
       "default", "template-override"
     ],
-    "xrefService": [
-       "https://xref.docs.microsoft.com/query?uid={uid}",
-       "https://omds.xaml.dev/xrefmap/net.xrefmap.json",
-       "https://omds.xaml.dev/xrefmap/netstandard.xrefmap.json",
-       "https://omds.xaml.dev/xrefmap/netwin.xrefmap.json",
-       "https://omds.xaml.dev/xrefmap/netios.xrefmap.json",
-       "https://omds.xaml.dev/xrefmap/netandroid.xrefmap.json",	   
-       "https://omds.xaml.dev/xrefmap/netuwp.xrefmap.json",
+    "xref": [
+       "../Output/dotnet.xrefmap.json",
+       "https://developers.arcgis.com/net/api-reference/net.xrefmap.yml",
+       "https://developers.arcgis.com/net/api-reference/netfx.xrefmap.yml",
+       "https://developers.arcgis.com/net/api-reference/netstandard.xrefmap.yml",
+       "https://developers.arcgis.com/net/api-reference/netwin.xrefmap.yml",
+       "https://developers.arcgis.com/net/api-reference/ios.xrefmap.yml",
+       "https://developers.arcgis.com/net/api-reference/android.xrefmap.yml",	   
+       "https://developers.arcgis.com/net/api-reference/uwp.xrefmap.yml",
     ],
     "postProcessors": [],
     "markdownEngineName": "markdig",

docs/docfx.json

@@ -5,4 +5,4 @@
 - name: API Reference
   href: api/index.md
 - name: GitHub
-  href: https://github.com/Esri/arcgis-toolkit-dotnet
+  href: https://github.com/Esri/arcgis-maps-sdk-dotnet-toolkit