docfx | Static site generator for .NET API documentation | REST library

I have a product with multiple repositories, each distributed as a NuGet package. I would like to establish a separate repository for DocFx, which generates the documentation from the NuGet packages. That way, it can consolidate the documentation for multiple { repositories, projects, packages } into one location, while also allowing conceptual documentation to be updated independent of the package release cycle.

TL;DR: I am able to get DocFx to correctly generate the reference documentation based on the assemblies in the NuGet package, but it doesn't include any of the XML documentation (i.e., from /// metadata). How do I solve this? Details below.

To pursue this, I first ensured that the csproj files for the source projects were configured to generate the XML documentation as part of the build output:

This question is the same as this question. But the OP answered his own question and it didn't help me.

I am trying to create a documentation similar to the Docfx site:

However, when I build the project, I get the index.html that looks like this:

My configuration is this:

• Installed docfx.console as a nuget package in Visual Studio 2017 for the project.
• The version of docfx is 2.58.0.
• I'm building the project in Visual Studio, which produces the docfx output.

My folder configuration is:

I am working on a Xamarin Forms project with Android target using Azure DevOps for CI. My project builds well in my local machine and also in the Azure Pipeline. Now, I would like to generate the code documentation with DocFx. So, I configured a powershell script to download docfx.console tool and execute it from my docfx.json file. The script works well on my local machine and the documentation is correctly generated.

I added a task in my Azure Pipeline to execute my powershell script and DocFx failed with a FileNotFoundException which concern the System.Buffers.dll file with the following logs:

Is there a way to generate a solution and project file out of a folder structure through a azure pipeline .ymal stage?

The way the project has been set up is that there are lots of other .git repos set up inside a master repo and inserted though subtrees. These repos don't have a .sln in themselves but instead when they are added into Unity they get added into the projects .sln and a .csproj is generated for each of the assemblies within the submodule (package)

What I'm looking to do is to have documentation generated for each of these submodules whenever an update is pushed to its master (not the projects it lives in master) as these tend to be more utilities and self contained systems. Problem I'm facing is that I can trigger all the documentation system with docFX but because this module does not contain a .csproj I'm unable to generate the documentation for it. so I'm wondering if its possible to have a step where I can create a project file for all scripts that are within a folder structure, and as such then have a project file for docFX to work of.

I know its not ideal in any sense, but wondering if its a possibility while I investigate further into other solutions.

How to document Union type in typescript so typedoc can pull/show relevant info? This below is a JSDoc reference but is there one for TSDoc?

Example

Whenever I try to build any documentation using docfx, I get the following error in the metadata build step that uses msbuild to analyze the xml comments in the code of the csprojs:

Warning:MetadataCommand.ExtractMetadataWorkspace failed with: [Failure] Msbuild failed when processing the file 'C:\temp\docfxtest\docfx_project\src\src.csproj' with message: Could not load SDK Resolver. A manifest file exists, but the path to the SDK Resolver DLL file could not be found. Manifest file path 'C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\MSBuild\15.0\Bin\SdkResolvers\Microsoft.Build.NuGetSdkResolver\Microsoft.Build.NuGetSdkResolver.xml'. SDK resolver path: C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\Common7\IDE\CommonExtensions\Microsoft\NuGet\Microsoft.Build.NuGetSdkResolver.dll C:\temp\docfxtest\docfx_project\src\src.csproj

It seems that msbuild cannot be correctly resolved by docfx. Any idea how I could fix this?

Im using docfx version 2.56.5.0 on Windows and I also have VS Enterprise 2019 (16.8.2) and VS Build Tools 2017 (15.9.29) installed:

UPDATE:

I have now uninstalled the VS 2017 build tools completely and repaired the VS 2019 installation using the installer. I now get a different error when I run docfx. It seems that it can't find msbuild at all anymore.

Warning:MetadataCommand.ExtractMetadataWorkspace failed with: [Failure] Msbuild failed when processing the file 'C:\temp\docfxtest\docfx_project\src\src.csproj' with message: The SDK 'Microsoft.NET.Sdk' specified could not be found. C:\temp\docfxtest\docfx_project\src\src.csproj

Running msbuild -t:restore,build also shows that it can't find msbuild

'msbuild' is not recognized as an internal or external command

The targets are isntalled:

And so is the .NET Core workload:

I get a failure for the stage 'Static analysis' during my jenkins-pipeline.

Here is my Jenkinsfile :

I have a DocFx project folder which contains all the correct files to host the project. On my laptop, I'm able to use the code docfx docfx.json --serve to host the project on my localhost completely fine. However on my PC it errors out.

I'm syncing my files using GitHub, so the files / file locations are identical. Also Initially it worked on my PC, then it stopped...

The error I'm getting is this:

[20-10-10 04:54:46.403]Error:System.IO.DirectoryNotFoundException: Could not find a part of the path 'C:\Windows\System32\docfx_project\obj.cache\build\4t5lswwe.fue\dynp2fa1.gsl'. at System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)

Complete Error Image

Current Directory:

PS C:\Users\aiden\Documents\GitHub\TAFE.2020.S2.SMALL.GROUP.PROJECT\docfx_project>

As you can see, my current directory is the project directory. However the error message states it's trying to pull docfx data files from within' system32. The files it is trying to pull are within' my docfx project.

Since it cannot find the files in system32, it errors out.

Anyone know how or why this is happening??

I have some .md files that are happily built into articles of a site generated by docfx. The landing page of this site which at the moment is a index.md file is empty. I have a separate static html page that its content is rendered by javascript containing some graph etc. What I would like to do is to render this html content as the landing page of the docfx site.

How do I do that?

Any help is much appreciated. Thanks.