Class Docset

Namespace

Docfx

Assembly

Docfx.App.dll

Provides access to a set of documentations and their associated configs, compilations and models.

public static class Docset

Inheritance

object

Docset

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Methods

Build(string)

Builds a docset specified by docfx.json config.

public static Task Build(string configPath)

Parameters

configPath string

The path to docfx.json config file.

Returns

Task

A task to await for build completion.

Build(string, BuildOptions)

Builds a docset specified by docfx.json config.

public static Task Build(string configPath, BuildOptions options)

Parameters

configPath string

The path to docfx.json config file.

options BuildOptions

The build options.

Returns

Task

A task to await for build completion.

Pdf(string)

Builds a pdf specified by docfx.json config.

public static Task Pdf(string configPath)

Parameters

configPath string

The path to docfx.json config file.

Returns

Task

A task to await for build completion.

Pdf(string, BuildOptions)

Builds a pdf specified by docfx.json config.

public static Task Pdf(string configPath, BuildOptions options)

Parameters

configPath string

The path to docfx.json config file.

options BuildOptions

The build options.

Returns

Task

A task to await for build completion.