DocFX project tasks
Tasks to build and bundle DocFx documentation projects.
Context
It provides build state information for the DocFx tasks. These properties are
defined in the
DocFxBuildContext
class.
| Property | Default value | CLI argument | Description |
|---|---|---|---|
DocFxFile |
./docs/docfx.json |
Path to DocFx project file | |
ChangelogDocPath |
./docs/articles/changelog.md |
Path to copy the changelog in the documentation | |
ToolingVerbosity |
From Cake verbosity | Verbosity for DocFx commands |
Tasks
Tasks are prefixed with PleOps.Recipe.DocFx. The class
DocFxTasks contains their
full names.
Build
- Task name:
PleOps.Recipe.DocFx.Build - Type:
BuildTask - Depends on:
RestoreTools - Condition: none
- Build context:
PleOpsBuildContext- Uses:
ChangelogFileWarningsAsErrorsDocFxContext.DocFxFileDocFxContext.ChangelogDocPathDocFxContext.ToolingVerbosityDeliveriesContext.DocumentationPath
- Changes: none
- Uses:
Build the DocFx documentation project (if it exists). It copies first the changelog file into the documentation designated path (if it exists).
The output folder goes into the artifacts folder
(DeliveriesContext.DocumentationPath).
The build may stop if there are warnings and WarningsAsErrors is enabled.
Bundle
- Task name:
PleOps.Recipe.DocFx.Bundle - Type:
BundleTask - Depends on:
Build - Condition: none
- Build context:
PleOpsBuildContext- Uses:
ArtifactsPathDeliveriesContext.DocumentationPath
- Changes: none
- Uses:
Zip the documentation folder into a zip file in the artifacts folder. The output
file name is docs.zip.