Table of Contents

Class DocFxBuildContext

Namespace
Cake.Frosting.PleOps.Recipe.DocFx
Assembly
Cake.Frosting.PleOps.Recipe.dll

Build context for DocFx documentation projects.

public class DocFxBuildContext
Inheritance
DocFxBuildContext
Inherited Members

Constructors

DocFxBuildContext()

Initializes a new instance of the DocFxBuildContext class.

public DocFxBuildContext()

Properties

ChangelogDocPath

Gets or sets the path to put the changelog file in the documentation.

public string ChangelogDocPath { get; set; }

Property Value

string

DocFxFile

Gets or setse the path to the docfx.json file.

public string DocFxFile { get; set; }

Property Value

string

ToolingVerbosity

Gets or sets the tooling verbosity.

public string ToolingVerbosity { get; set; }

Property Value

string

Methods

ReadArguments(PleOpsBuildContext)

Initializes the information from the build context.

public void ReadArguments(PleOpsBuildContext context)

Parameters

context PleOpsBuildContext

Cake context.

Exceptions

NotSupportedException

Invalid cake verbosity.