How to create documentation using Sandcastle NuGet (EWSoftware.SHFB)?

Question

I am trying to create site documentation for my C # code using the NuGet Sandcastle package in Visual Studio (EWSoftware.SHFB). The fact is that I do not know how to use it. I install it from the NuGet package manager, and then I have no idea what to do with it.

I have no problem editing my documentation project and creating an appropriate website using the VS Sandcaslte extension installed with the default installer.

Thank you for your help.

Answer 1

MsBuild.exe MyDocumentationProject.shfbproj . , VS, .

Beforhand, https://github.com/EWSoftware/SHFB/blob/master/NuGet/ReadMe.txt:

• ComponentPath MyDocumentationProject.shfbproj .

  <PropertyGroup>
    <ComponentPath>$(MSBuildThisFileDirectory)..\packages\EWSoftware.SHFB.NETFramework.4.6</ComponentPath>
  </PropertyGroup>
  

• SHFB ​​ MyDocumentationProject.shfbproj.

  <PropertyGroup>
    <SHFBROOT Condition=" '$(SHFBROOT)' == '' ">$(MSBuildThisFileDirectory)..\packages\EWSoftware.SHFB.2015.10.10.0\Tools\</SHFBROOT>
  </PropertyGroup>
  

Answer 2

, , "" .

, csproj, .

.

Answer 3

Visual Studio Sandcastle.

:

IF "$(ConfigurationName)"=="Debug" Goto Exit

ECHO Building SHFB help file via MSBuild
"$(SystemRoot)\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe"  /p:CleanIntermediates=True /p:Configuration=Release "$(SolutionDir)Documentation\Documentation.shfbproj"

:Exit

SHFB :

<!-- NOTE: Update the version number in the path (YYYY.M.D.R) to match the package version -->
<SHFBROOT Condition=" '$(SHFBROOT)' == '' ">$(MSBuildThisFileDirectory)..\packages\EWSoftware.SHFB.2016.9.17.0\tools\</SHFBROOT>

Sandcastle , NuGet. , .

, :

• Team Build