Module
PuduLangDocgen.Docset.Tasks
Project scaffolding, template export, printing, and reference maps
Functions
| Name | Description |
|---|---|
init |
A new project written into a folder; a folder that already holds a configuration is left alone. |
exportTemplate |
The default layout, partials, and assets written into a folder for customization. |
pdf |
Printable documents for every table that sets `pdf`, published and then rendered to PDF. |
download |
A cross-reference map saved from a web address after checking that it reads. |
merge |
Cross-reference maps read from files or web addresses and written as one; the first map to declare an identity keeps it. |
init
fn init(folder: Str, answers: &Scaffold.Answers) -> Result[Array[Str], Array[Docgen.Diagnostic]]
A new project written into a folder; a folder that already holds a configuration is left alone.
Parameters
folderStranswers&Scaffold.Answers
Returns
Result[Array[Str], Array[Docgen.Diagnostic]]
exportTemplate
fn exportTemplate(folder: Str) -> Result[Array[Str], Array[Docgen.Diagnostic]]
The default layout, partials, and assets written into a folder for customization.
Parameters
folderStr
Returns
Result[Array[Str], Array[Docgen.Diagnostic]]
fn pdf(base: Str, built: &Build.Built, output: Str, renderer: &Array[Str]) -> Result[Array[Str], Array[Docgen.Diagnostic]]
Printable documents for every table that sets pdf, published and then rendered to PDF.
Parameters
baseStrbuilt&Build.BuiltoutputStrrenderer&Array[Str]
Returns
Result[Array[Str], Array[Docgen.Diagnostic]]
download
fn download(address: Str, file: Str) -> Result[Int, Array[Docgen.Diagnostic]]
A cross-reference map saved from a web address after checking that it reads.
Parameters
addressStrfileStr
Returns
Result[Int, Array[Docgen.Diagnostic]]
merge
fn merge(sources: &Array[Str], file: Str) -> Result[Int, Array[Docgen.Diagnostic]]
Cross-reference maps read from files or web addresses and written as one; the first map to declare an identity keeps it.
Parameters
sources&Array[Str]fileStr
Returns
Result[Int, Array[Docgen.Diagnostic]]