Class DocFXGenerator

Generates DocFX documentation.

Inheritance

object

DocFXGenerator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Microsoft.XboxStudios.NukeExt

Assembly: NukeExt.Components.dll

Syntax

public static class DocFXGenerator

Methods

RemoveCloudBuildVersionSettings(string)

Adjusts the Nerdbank GitVersioning JSON file to avoid a hang in Azure DevOps. In particular, in the cloudBuild section, the setVersionVariables setting must be false (it is true by default), and then in the buildNumber sub-section the enabled setting must be false (we usually configure this to true). See https://github.com/dotnet/docfx/issues/10144

Declaration

public static void RemoveCloudBuildVersionSettings(string versionFile)

Parameters

Type	Name	Description
string	versionFile	The version.json file path.

Run(AbsolutePath, AbsolutePath, string)

Runs DocFX.

Declaration

public static void Run(AbsolutePath documentationDirectory, AbsolutePath documentationOutputDirectory, string apiOutputDirectory = "api")

Parameters

Type	Name	Description
AbsolutePath	documentationDirectory	The directory containing docfx.json.
AbsolutePath	documentationOutputDirectory	The directory to use for output.
string	apiOutputDirectory	The sub-directory containing API output.