SwiftDocCUtilities

Build custom documentation workflows by leveraging the DocC compiler pipeline.

Overview

SwiftDocCUtilities provides a default, command-line workflow for DocC, powered by Swift Argument Parser. docc commands, such as convert and preview, are conformant Action types that use DocC to perform documentation tasks.

Use SwiftDocCUtilities to build a custom, command-line interface and extend it with additional commands. To add a new sub-command called example, create a conformant Action type, ExampleAction, that performs the desired work, and add it as a sub-command. Optionally, you can also reuse any of the provided actions like ConvertAction.

public import ArgumentParser

public struct MyDocumentationTool: AsyncParsableCommand {
    public static var configuration = CommandConfiguration(
        abstract: "My custom documentation tool",
        subcommands: [ConvertAction.self, ExampleAction.self]
    )
    
    public init() {
    }
}

MyDocumentationTool.main()

Adding a new sub-command automatically adds routing and execution of its code, adds its description to the command-line help menu, and ensures validation for its expected arguments.

Topics

Compiler Workflow

Actions Design

struct ActionResult
The result of executing an action.

Execution Workflow

Protocols

protocol DirectoryPathOption
A parsable argument for an optional directory path.

Structures

Enumerations

enum CatalogTemplateKind
Specifies the different template kinds available for initializing the documentation catalog.