This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see
Cake.DocFx.
Summary
Merge base API in YAML files and toc files for a specific docfx.json file using the specified settings.
Syntax
public static void DocFxMerge(this ICakeContext context, FilePath configFile, DocFxMergeSettings settings)
Examples
DocFxMerge("./docs/docfx.json", new DocFxMergeSettings
{
TocMetadata = { "platform" },
WarningsAsErrors = true
});
Attributes
| Type |
Description |
| CakeMethodAliasAttribute |
|
| CakeAliasCategoryAttribute |
|
Parameters
| Name |
Type |
Description |
| context |
ICakeContext |
The Cake context. |
| configFile |
FilePath |
The optional path to a DocFx config file.
If no value is passed the docfx.json file in the current working directory will be used. |
| settings |
DocFxMergeSettings |
The optional DocFx settings.
If no settings are passed default settings are used. |
Return Value
