-
Notifications
You must be signed in to change notification settings - Fork 158
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
Generating API documentation for a library that uses 3rd-party dependencies fails #616
Comments
Hmm interesting, yes. I guess ideally we'd point everything at a tests folder (i.e. an application) that has all dependencies bundled. |
I did this recently in MiniScaffold where we do a Aside: I didnt realize how far along you've gotten with fsdocs. I think it's time to for me to consider retiring my docsTool stuff and contribute to this repo. |
@TheAngryByrd we can't do that from the command tool though. 😢 |
Yeah I was more pointing to how this I solved the problem and how this repo could fix it. |
Same situation, different stack trace (from Dash.NET):
Would it be valuable to add a command line argument (maybe something like |
We could, perhaps as an interim measure, though I think this is the solution we may need to follow: "ideally we'd point everything at a tests folder (i.e. an application) that has all dependencies bundled." It may also be possible to set some flag in the project file marking the project as a test DLL (even if it actually isn't), to ensure dependencies get copied to the output directory. That may have the side effect of zero tests being found on test execution though. Not sure if it's a problem |
.NET Core has a type that does the entire work for us. |
I see thanks, nice. Maybe that's enough. |
@teo-tsirpanis , I will take a look I think I need it for a similar notebook scenario anyway. |
@dsyme , @teo-tsirpanis , I think the suggested API, may help us out in FSI. However, I don't think the compiler itself should work off ambient types, the compiler ideally knows all of the assemblies that contribute to a successful build. If this scenario is important for fsdocs then I suppose that fsdocs should implement an AssemblyLoadContext that does this work. |
Hello, we are having the same problem. One project has a NuGet dependency so the cracking fails from the command line.
Notice that this requires an additional space before the Would a PR be accepted that trims all entries of
? This would resolve our generation problem when running the tool. //cc @yisusalanpng |
Yes, sounds good |
FYI, I encountered a same error when I use the newest SDK version |
Consider the attached example library. It defines a library with a class with a property that returns a
Newtonsoft.Linq.JToken
.dotnet fsdocs build
ing the project fails withHow to generate documentation for a library that uses 3rd-party types in its API?
It looks like that the command tool has trouble finding the references for the assemblies it processes. One solution would have been through the
AssemblyDependencyResolver
class.The text was updated successfully, but these errors were encountered: