rlsbl.targets.docs

Docs target -- generates documentation from source code docstrings.

This is an optional target that doesn't manage its own version or tag. It hooks into the build/publish lifecycle to extract docs from Python sources, generate Markdown/HTML, and deploy to Cloudflare or GitHub Pages.

Classes

DocsTarget

Release target for documentation generation and deployment.

detect

def detect(self, dir_path)

True if .rlsbl/docs.toml exists in the given directory.

read_version

def read_version(self, dir_path)

Docs don't have their own version -- return fallback.

This target is never the primary target; it piggybacks on the primary target's version. Return "0.0.0" as a safe default.

write_version

def write_version(self, dir_path, version)

No-op: docs inherit version from primary target.

version_file

def version_file(self)

No version file -- docs inherit from primary target.

tag_format

def tag_format(self, name, version)

No separate tag -- uses primary target's tag.

build

def build(self, dir_path, version)

Extract docs from Python sources, generate Markdown and HTML.

publish

def publish(self, dir_path, version)

Deploy docs to configured provider (Cloudflare Pages or GitHub Pages).