Module

PuduLangDocgen.Docset.Tools

Git history, diagram rendering, and remote reference maps

Functions

Name	Description
`history`	The latest change date of every file git tracks under a folder, or none without git.
`repository`	The repository behind edit links: configured values first, then environment variables of the running build service, then the local clone's `origin` remote and current branch.
`diagrams`	PlantUML sources drawn by a local renderer as SVG data addresses; failures are reported and leave the remote server to draw that diagram.
`references`	References from cross-reference maps named by web address or project path.
`fetch`	The body of a web address fetched within the deadline.

history

fn history(base: Str) -> Map[Str, Str]

The latest change date of every file git tracks under a folder, or none without git.

Parameters

base: Str

Returns

Map[Str, Str]

View source

repository

fn repository(base: Str, configured: &Configuration.Contribution) -> Configuration.Contribution

The repository behind edit links: configured values first, then environment variables of the running build service, then the local clone's origin remote and current branch.

Parameters

base: Str
configured: &Configuration.Contribution

Returns

Configuration.Contribution

View source

diagrams

fn diagrams(sources: &Array[Str], settings: &Configuration.Diagrams) -> (Map[Str, Str], Array[Docgen.Diagnostic])

PlantUML sources drawn by a local renderer as SVG data addresses; failures are reported and leave the remote server to draw that diagram.

Parameters

sources: &Array[Str]
settings: &Configuration.Diagrams

Returns

(Map[Str, Str], Array[Docgen.Diagnostic])

View source

references

fn references(base: Str, sources: &Array[Str]) -> (Array[Docgen.Reference], Array[Docgen.Diagnostic])

References from cross-reference maps named by web address or project path.

Parameters

base: Str
sources: &Array[Str]

Returns

(Array[Docgen.Reference], Array[Docgen.Diagnostic])

View source

fetch

fn fetch(address: Str) -> Result[Str, Str]

The body of a web address fetched within the deadline.

Parameters

address: Str

Returns

Result[Str, Str]

View source