Package software.amazon.smithy.docgen

Interface DocIntegration

All Superinterfaces:

SmithyIntegration<DocSettings,DocWriter,DocGenerationContext>

All Known Implementing Classes:

BuiltinsIntegration, SphinxIntegration

public interface DocIntegration
extends SmithyIntegration<DocSettings,DocWriter,DocGenerationContext>

Allows integrating additional functionality into the documentation generator.

DocIntegrations are loaded as a Java SPI. To make your integration discoverable, add a file to META-INF/services named software.amazon.smithy.docgen.DocIntegration where each line is the fully-qualified class name of your integrations. Several tools, such as AutoService, can do this for you.

Method Summary

Modifier and Type	Method	Description
default List<DocFormat>	docFormats(DocSettings settings)	Adds DocFormats to the list of supported formats.

Methods inherited from interface software.amazon.smithy.codegen.core.SmithyIntegration

configure, customize, decorateSymbolProvider, interceptors, name, preprocessModel, priority, runAfter, runBefore

Method Details

docFormats

default List<DocFormat> docFormats(DocSettings settings)

Adds DocFormats to the list of supported formats.

When resolving the format implementation, the first format found with a matching name will be used. Use SmithyIntegration.priority() to adjust which integration is seen first.

Parameters:

settings - The documentation generation settings.

Returns:

A list of formats to add.