-
Notifications
You must be signed in to change notification settings - Fork 632
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: DocFx Build Failure for API Docs #911
Comments
oh my :( |
@Shazwazza - Yeah, I think we will need to download the docfx source and run it in the debugger to determine how to fix the load issues with the plugins and also fix the MavenReference problem. For MavenReference I think we may need to switch to using the DLL/XML output instead of using the |
On my environment. 1. Remove MSBuild It seems this settings override target framework( lucenenet/websites/apidocs/docfx.analysis-opennlp.json Lines 17 to 19 in 43e0e89
2. Build with .NET 8 SDK v
Minimum reproducible
|
When I try to run the docs.ps1 script on macOS arm64, I get the following error after the "Building api metadata for..." lines:
|
Is there an existing issue for this?
Describe the bug
The API documentation is failing to build. The website is generated with no URLs being resolved.
Expected Behavior
The documentation will build and all links will be resolvable.
Steps To Reproduce
./websites/apidocs/docs.ps1 -ServeDocs -LuceneNetVersion 4.8.0-beta00016 -BaseUrl http://localhost:8080
See the API Docs build instructions.
Exceptions (if any)
Lucene.NET Version
Lucene.NET 4.8.0-beta00016
.NET Version
No response
Operating System
Windows 10 x64
Anything else?
I did a search and discovered the following issue that appears to be the same problem:
dotnet/docfx#8097
The solution was to upgrade to 2.59.4. I attempted that next, and then got hit with the error that
System.Memory
had multiple versions referenced and could not load it similar to this comment.In this case, we recently added a dependency on the
System.Memory
4.5.5 NuGet package. Unfortunately, it seems that docfx has its own reference so it cannot resolve this, even if changing the assembly binding redirects.Upgrade docfx to .NET Core?
Since it seems we have unresolvable conflicts, I attempted to upgrade to version 2.75.2 (which is now on .NET Core). It seems there have been some architecture changes, so I ran into the following issues:
--cleanupCacheHistory
,--force
, and--forcePostProcess
options no longer exist on docfx. I did a search in their repository, but it isn't clear why they were removed or what the recommended replacement is.net6.0
, sincenetstandard2.0
is not supported by IKVM.<MavenReference>
to build and add references on the fly, but docfx isn't running the<MavenReference>
when building. See Roslyn error when trying to build API docs using docfx when there is a <MavenReference> ikvmnet/ikvm-maven#53.A few things to note:
--toolpath
.<MavenReference>
, docfx can build docs based off of either source code or the combination of DLL and XML (docs file).The text was updated successfully, but these errors were encountered: