Fix multiple issues with links going to TestFramework instead of Core

apache · Oct 10, 2024 · 189a213 · 189a213
1 parent 8290f57
commit 189a213
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 9 deletions.
diff --git a/websites/apidocs/docfx.site.json b/websites/apidocs/docfx.site.json
@@ -53,7 +53,6 @@
       "_site/api/sandbox/xrefmap.yml",
       "_site/api/spatial/xrefmap.yml",
       "_site/api/suggest/xrefmap.yml",
-      "_site/api/test-framework/xrefmap.yml",
       "_site/api/demo/xrefmap.yml"
     ],
     "dest": "_site",

diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1
@@ -192,23 +192,18 @@ if ($? -and $DisableBuild -eq $false) {
 }
 
 if ($?) {
-
-    # Before we build the site we have to clear the frickin docfx cache!
-    # else the xref links don't work on the home page. That is crazy.
-    Remove-Item (Join-Path -Path $ApiDocsFolder "obj\.cache") -recurse -force -ErrorAction SilentlyContinue
-
     $DocFxLog = Join-Path -Path $ApiDocsFolder "obj\docfx.site.json.log"
 
     if ($ServeDocs -eq $false) {
 
         # build the output
         Write-Host "Building docs..."
-        & dotnet tool run docfx $DocFxJsonSite --log "$DocFxLog" --logLevel $LogLevel --debug
+        & dotnet tool run docfx $DocFxJsonSite --log "$DocFxLog" --logLevel $LogLevel --debug --maxParallelism 1
     }
     else {
         # build + serve (for testing)
         Write-Host "starting website..."
-        & dotnet tool run docfx $DocFxJsonSite --log "$DocFxLog" --logLevel $LogLevel --serve --port $StagingPort --debug
+        & dotnet tool run docfx $DocFxJsonSite --log "$DocFxLog" --logLevel $LogLevel --serve --port $StagingPort --debug --maxParallelism 1
     }
 }
 

diff --git a/websites/apidocs/index.md b/websites/apidocs/index.md
@@ -40,6 +40,9 @@ on some of the conceptual or inner details of Lucene:
 
 ## Libraries
 
+<!-- NOTE: The namespace collisions in test-framework require it to be linked without
+    a xref style link. This also is why test-framework's xrefmap is not in docfx.site.json. -->
+
 - <xref:Lucene.Net> - Core library
 - <xref:Lucene.Net.Analysis.Common> - Analyzers for indexing content in different languages and domains
 - [Lucene.Net.Analysis.Kuromoji](xref:Lucene.Net.Analysis.Ja) - Japanese Morphological Analyzer
@@ -65,7 +68,7 @@ on some of the conceptual or inner details of Lucene:
 - <xref:Lucene.Net.Sandbox> - Various third party contributions and new ideas
 - [Lucene.Net.Spatial](xref:Lucene.Net.Spatial) - Geospatial search
 - <xref:Lucene.Net.Suggest> - Auto-suggest and Spell-checking support
-- <xref:Lucene.Net.TestFramework> - Framework for testing Lucene-based applications
+- [Lucene.Net.TestFramework](api/test-framework/overview.html) - Framework for testing Lucene-based applications
 
 ### Tools