DocsModuleHandler

abstract class DocsModuleHandler(projectDir: File, docsGenerator: DocsGenerator)

Abstract class handling documentation module tasks.

projectDir

The root directory of the project.

docsGenerator

A DocsGenerator instance for generating documentation.

Constructors

constructor(projectDir: File, docsGenerator: DocsGenerator)

Manages dependencies for the documentation module. (Implementations should provide specific logic).

abstract fun updateMkDocs(mkDocsPath: String = "mkdocs.yml", section: String = "Changelog")

Updates the MkDocs configuration file. (Implementations should provide specific logic).

fun writeMkDocs(mkDocsPath: String, section: String, version: String)

Writes a new entry to the specified section in the MkDocs Changelog.

Writes release notes for the current version. (Implementations should provide specific logic).