documentator
Automatic documentation generation from function information and docstrings. Requires that the zepto version of mustache is installed.
Usage
A command-line tool is included so as to make working with the tool easier:
git clone https://github.com/zepto-lang/documentator
# This will generate documentation for a single function
zepto documentator/cmd.zp --output-file foo.html --function vector:head
# This will generate documentation for a namespace
zepto documentator/cmd.zp --output-file foo.html --function "vector:*"
# "*" will be treated as a wildcard and make documentation
# for all of zeptos prelude. This generates documentation
# for 459 function at the time of writing and takes some time
# (13 seconds on my machine)
zepto documentator/cmd.zp --output-file foo.html --function "*"Example output for the tool can be found in the examples directory,
where the current (2015-19-12) output of requesting documentation
for all the functions can be found.
Hacking your own documentation tool
Of course you can hack your own documentation tool on top of documentator, although for now it is not intended to be used as a framework and very specifc. The code underlying this module can be easily modified for generalization, though.
Have fun!