Comments (11)
The URL cache file might be corrupted. Delete the %USERPROFILE%\Local Settings\Application Data\EWSoftware\Sandcastle Help File Builder\Cache folder and it will rebuild it.
from shfb.
Strangely I'm getting an error with the .NET SDK 6.0.25 too (which does not disable BinaryFormatter
), but there the root exception is different:
Attempting to deserialize an empty stream.
at System.Runtime.Serialization.Formatters.Binary.BinaryFormatter.Deserialize(Stream serializationStream)
at Sandcastle.Tools.BuildComponents.ResolveReferenceLinksComponent.CreateMemberIdResolver(XPathNavigator configuration)
at Sandcastle.Tools.BuildComponents.ResolveReferenceLinksComponent.Initialize(XPathNavigator configuration)
at SandcastleBuilder.Utils.BuildEngine.BuildAssemblerInternal.LoadComponent(XPathNavigator configuration)
from shfb.
I'm aware of the issue. The cache used to contain resolved reference links is stored in a binary format. I've found a way to generate the links without the web service thus removing the need for the cache altogether. It may be a few weeks before I get it done and release an update though.
from shfb.
Any idea on what the second issue (empty stream) could be?
I am running into that on every attempt to build any SHFB project, even with msbuild.exe
(which uses .NET Framework, so no BinaryFormatter
issue).
Even with the (now very old) SHFB version we're using in CI:
BuildAssembler (v2020.3.6.0)
Copyright c 2006-2020, Microsoft Corporation, All Rights Reserved.
Portions Copyright c 2006-2020, Eric Woodruff, All Rights Reserved.
Loading configuration...
BuildAssembler : error : [C:\path\to\project\output\Release\Website\BuildTopics.proj]
BuildAssembler : error : BuildAssemblerCore: An unexpected error occurred while attempting to create the build component 'Resolve Reference Links Component'. The error message is: Attempting to deserialize an empty stream. [C:\path\to\project\output\Release\Website\BuildTopics.proj]
BuildAssembler : error : [C:\path\to\project\output\Release\Website\BuildTopics.proj]
BuildAssembler : error : BuildAssemblerCore: An unexpected error occurred while attempting to create the build component 'Multi-format Output Component'. The error message is: See log for details [C:\path\to\project\output\Release\Website\BuildTopics.proj]
BuildAssembler : error : [C:\path\to\project\output\Release\Website\BuildTopics.proj]
BuildAssembler : error : BuildAssemblerCore: An unexpected error occurred while attempting to create the build component 'Switch Component'. The error message is: See log for details [C:\path\to\project\output\Release\Website\BuildTopics.proj]
Done Building Project "C:\path\to\project\output\Release\Website\BuildTopics.proj" (default targets) -- FAILED.
Unfortunately, there's no logging (even with -v:d) that would indicate what stream it's trying to read (a file? a url?).
It does seem specific to my machine at the moment (a colleague using the same VS2022 version and .NET 8SDK installed is able to build without error), making it even weirder. I did try clearing my temporary files folder as well as my nuget cache in case there was an issue there, with no change.
from shfb.
That was it, thanks. Is there a way to inhibit that file's use, or configure its location, from the project file?
I'm not sure I like the idea that a single broken file can break all builds on a machine; that could significantly disrupt CI/CD.
from shfb.
Note that I'm now getting:
BuildAssembler : warning : ResolveReferenceLinksComponent: ... Member ID URL resolver service failed. No further look ups will be performed for this build. [...\BuildTopics.proj]
BuildAssembler : warning : Reason: The remote server returned an error: (403) Forbidden. [...\BuildTopics.proj]
from shfb.
The service (https://xref.docs.microsoft.com) is currently returning an error. It may be temporary or Microsoft may have shut it down. I know the latest release of DocFX no longer uses it though older version still would. The old MSDN web service stayed up for quite a while but became unreliable which is why I switched away from it. Eventually the same will happen to the latest service which is why I'm working on moving away from it and going with code-based generation of the links since they use a deterministic format now.
from shfb.
@EWSoftware Hi. Do you have a rough idea of when a release could be published (including the 8.0.0 version of SHFB.NET)?
from shfb.
My free time has been rather limited of late. I'm going to try again this weekend to get it published. I've got Monday off so should be able to get it out.
from shfb.
Version 2024.2.18.0 is now available along with the updated reflection data set packages.
from shfb.
Awesome! Thanks a lot.
from shfb.
Related Issues (20)
- Numeric constant formatting for enumeration to allow searching for constant HOT 2
- Error BE0065: An error occurred while attempting to transform the reflection data to a topic. When Extensions Methods to Enum. HOT 3
- Some types excluded from documentation? HOT 3
- Documenting a `net8.0` project when using `msbuild.exe` HOT 3
- Linux/Docker builds HOT 5
- An error occurred while attempting to transform the reflection data to a topic. The error message was: System.NullReferenceException HOT 3
- Problem with installer when only VS 2022 is installed. HOT 4
- Support for Nuget Central Package Management
- CodeBlockComponent: F# closing endregion comment tag included in rendered text.
- Sandcastle is running out of memory HOT 7
- HowTo - Install current HTML Help 1 Compiler for Client, Server or Docker image HOT 1
- Add Project Error in VS2022 Community HOT 2
- Build fails with "System.Drawing.Common is not supported on this platform" error when using '<alert>' element in '.aml' conceptual doc and 'Open XML Document' output style HOT 3
- Add some text in HTML documentation HOT 3
- Comment XML not recognized HOT 4
- Linked content files in SHFB project get not resolved HOT 4
- Possible to change first letter of class name to lower case? HOT 4
- seealso tag inside of remarks tag renders incorrectly in Default 2022 HOT 2
- Whitespace ignored if two formatted worlds are next to each other. HOT 1
- Bug - Build fails when using Version builder plugin and project contains method extending enum HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from shfb.