DocFxBuildAliases Class

Summary

Contains functionality related to building websites using DocFx.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["DocFxBuildAliases"] class Type type-node

Syntax

public static class DocFxBuildAliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
DocFxBuild(ICakeContext) void
Generate client-only website combining API in YAML files and conceptual files for the docfx.json file in the current working directory.
static
DocFxBuild(ICakeContext, DocFxBuildSettings) void
Generate client-only website combining API in YAML files and conceptual files for the docfx.json file in the current working directory using the specified settings.
static
DocFxBuild(ICakeContext, FilePath) void
Generate client-only website combining API in YAML files and conceptual files for a specific docfx.json file.
static
DocFxBuild(ICakeContext, FilePath, DocFxBuildSettings) void
Generate client-only website combining API in YAML files and conceptual files for a specific docfx.json file using the specified settings.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin