Documentation Language: Swift

Method

generate()

Generates static HTML documentation.

func generate() async throws -> GenerationResult

Return Value

A result containing information about the generated documentation.

Discussion

This method performs the following steps:

  1. Generates symbol graphs using the Swift Package Manager

  2. Runs docc convert to create a temporary .doccarchive

  3. Parses the JSON render nodes from the archive

  4. Renders all pages to static HTML

  5. Writes CSS and JavaScript assets

  6. Optionally generates a search index