DocFXGenerator Class

Definition

Generates DocFX documentation.

C#

public static class DocFXGenerator

Inheritance object

Methods

Run(AbsolutePath, AbsolutePath, bool)

Runs DocFX.

C#

[SuppressMessage("Globalization", "CA1308:Normalize strings to uppercase")]
public static void Run(AbsolutePath documentationDirectory, AbsolutePath documentationOutputDirectory, bool metadataOnly)

Parameters

documentationDirectory Nuke.Common.IO.AbsolutePath
The directory containing docfx.json.

documentationOutputDirectory Nuke.Common.IO.AbsolutePath
The directory to use for output.

metadataOnly bool
Whether to generate DocFX metadata or a full build.

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

C#

public static void RemoveCloudBuildVersionSettings(string versionFile)

Parameters

versionFile string
The version.json file path.