DocFx

Summary

Contains functionality related to merging base API files using DocFx.

Build

DocFx(ICakeContext) Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext) instead.
Addin from Cake.DocFx.dll
DocFx(ICakeContext, DocFxSettings) Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext,Cake.DocFx.Build.DocFxBuildSettings) instead.
Addin from Cake.DocFx.dll
DocFx(ICakeContext, FilePath) Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath) instead.
Addin from Cake.DocFx.dll
DocFx(ICakeContext, FilePath, DocFxSettings) Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.DocFx.Build.DocFxBuildSettings) instead.
Addin from Cake.DocFx.dll
DocFxBuild(ICakeContext) Generate client-only website combining API in YAML files and conceptual files for the docfx.json file in the current working directory.
Addin from Cake.DocFx.dll
DocFxBuild(ICakeContext, DocFxBuildSettings) 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.
Addin from Cake.DocFx.dll
DocFxBuild(ICakeContext, FilePath) Generate client-only website combining API in YAML files and conceptual files for a specific docfx.json file.
Addin from Cake.DocFx.dll
DocFxBuild(ICakeContext, FilePath, DocFxBuildSettings) Generate client-only website combining API in YAML files and conceptual files for a specific docfx.json file using the specified settings.
Addin from Cake.DocFx.dll

Init

DocFxInit(ICakeContext) Generate an initial docfx.json file.
Addin from Cake.DocFx.dll
DocFxInit(ICakeContext, DocFxInitSettings) Generate an initial docfx.json file, with the specified settings.
Addin from Cake.DocFx.dll

Merge

DocFxMerge(ICakeContext) Merge base API in YAML files and toc files for the docfx.json file in the current working directory.
Addin from Cake.DocFx.dll
DocFxMerge(ICakeContext, DocFxMergeSettings) Merge base API in YAML files and toc files for the docfx.json file in the current working directory using the specified settings.
Addin from Cake.DocFx.dll
DocFxMerge(ICakeContext, FilePath) Merge base API in YAML files and toc files for a specific docfx.json file.
Addin from Cake.DocFx.dll
DocFxMerge(ICakeContext, FilePath, DocFxMergeSettings) Merge base API in YAML files and toc files for a specific docfx.json file using the specified settings.
Addin from Cake.DocFx.dll

Metadata

DocFxMetadata(ICakeContext) Extract API documentation using DocFx for the docfx.json file in the current working directory.
Addin from Cake.DocFx.dll
DocFxMetadata(ICakeContext, DocFxMetadataSettings) Extract API documentation using DocFx, with the specified settings.
Addin from Cake.DocFx.dll
DocFxMetadata(ICakeContext, FilePath) Extract API documentation using DocFx for a specific docfx.json file.
Addin from Cake.DocFx.dll
DocFxMetadata(ICakeContext, IEnumerable<FilePath>) Extract API documentation using DocFx, with the specified project/source files or search patterns.
Addin from Cake.DocFx.dll

Pdf

DocFxPdf(ICakeContext) Generates a PDF document for the docfx.json file in the current working directory.
Addin from Cake.DocFx.dll
DocFxPdf(ICakeContext, DocFxPdfSettings) Generates a PDF document for the docfx.json file in the current working directory using the specified settings.
Addin from Cake.DocFx.dll
DocFxPdf(ICakeContext, FilePath) Generates a PDF document for a specific docfx.json file.
Addin from Cake.DocFx.dll
DocFxPdf(ICakeContext, FilePath, DocFxPdfSettings) Generates a PDF document for a specific docfx.json file using the specified settings.
Addin from Cake.DocFx.dll

Serve

DocFxServe(ICakeContext) Serve a website from the current directory.
Addin from Cake.DocFx.dll
DocFxServe(ICakeContext, DirectoryPath) Serve a website from the specified directory.
Addin from Cake.DocFx.dll
DocFxServe(ICakeContext, DirectoryPath, DocFxServeSettings) Serve a website from the specified directory with the specified settings.
Addin from Cake.DocFx.dll
DocFxServeStart(ICakeContext) Start serving a website from the current directory.
Addin from Cake.DocFx.dll
DocFxServeStart(ICakeContext, DirectoryPath) Start serving a website from the specified directory.
Addin from Cake.DocFx.dll
DocFxServeStart(ICakeContext, DirectoryPath, DocFxServeSettings) Start serving a website from the specified directory with the specified settings.
Addin from Cake.DocFx.dll