Usage
Autodoc lets you generate technical documentation for your project as a PDF or an HTML document.
Project documentation can be generated from the Putki Studio by clicking on the Putki icon in the upper left corner and selecting ‘Build Project Documentation’.
Configuration
In this initial release, the documentation can be configured from the autodoc.properties file in your installation folder: <PUTKI>/plugins/misc/autodoc/autodoc.properties.
The following properties are supported:
Property | Default | Description |
hop.config.folder | ${HOP_CONFIG_FOLDER} | (optional) Your Hop configuration folder. |
hop.project | The project to generate documentation for. This uses the current project in Putki by default. | |
temporary.folder | A folder to store temporary files. You’ll need permissions to create and clean up any files in this folder. The temporary folder will be removed after the docs have been successfully generated. | |
ignore.folders | A comma separated list of folders in the project to ignore. | |
output.pdf | Y | Generate PDF project documentation? |
output.pdf.filename | The PDF filename to generate. | |
output.pdf.template.filename | The filename for PDF YAML template to use while generating the PDF documentation. Autodoc uses Asciidoctor PDF to generate the documentation. Check Asciidoctor PDF Theming for more information. | |
output.html | Y | Generate HTML project documentation? |
output.html.filename | The HTML filename to generate. |