solidity-docgen

solidity-docgen

Documentation generator for smart contract libraries. Use the inline documentation in your Solidity code for generating websites or any sort of document.

The output is completely customizable through Handlebars templates that provide easy access to all the metadata of your smart contract.

Usage

Note: Detailed usage information is not available yet. Please be patient!

npm install solidity-docgen

solidity-docgen takes as input a directory of contracts and README documents. This directory is specified using the --input/-i flag, defaulting to ./contracts. It produces a set of files that it will place in the output directory specified by --output/-o, defaulting to ./docs.

solidity-docgen [ -i <input-dir> ] [ -o <output-dir> ] [ -t <templates-dir> ]

Changelog

0.5.5

• Fixed a bug in the contracts output structure that would result in contracts missing from the output if there was more than one defined in the same Solidity source file.

This is technically a breaking change in how output paths are generated, but it should not affect most people. In particular, users who follow the convention of naming Solidity files by the contract that they contain will not be affected at all. Users who follow a different convention and who use the contracts output structure (the default) will see output files generated in a different path.