scaffold-docs ( obj -- ) (original) (raw)

scaffold-docs ( obj -- )
Scaffold tool

Vocabulary
tools.scaffold

Inputs

Outputs
None

Word description
Takes a word or vocabulary name and creates a help file with scaffolded help for each word. For vocabulary names, if a file exists this word will not do anything.

See also
scaffold-undocumented, scaffold-examples

Definition

IN: tools.scaffold

GENERIC: scaffold-docs ( obj -- )

Methods

USING: io sequences tools.scaffold ;

M: sequence scaffold-docs [ scaffold-word-docs nl ] each ;

USING: kernel strings tools.scaffold tools.scaffold.private ;

M: string scaffold-docs
ensure-vocab-exists [
dup "-docs.factor" vocab/suffix>path scaffolding?
[ set-scaffold-docs-file ] [ 2drop ] if
] with-scaffold ;

USING: tools.scaffold vocabs ;

M: vocab-link scaffold-docs vocab-name scaffold-docs ;

USING: tools.scaffold vocabs ;

M: vocab scaffold-docs vocab-name scaffold-docs ;

USING: tools.scaffold words ;

M: word scaffold-docs scaffold-word-docs ;