Documentation generator for smart contract libraries.
solidity-docgen
allows you to document your code inline using NatSpec
comments (a format similar to Javadoc and JSDoc) and then produce a website
to publish the documentation.
Built with ❤️ by OpenZeppelin.
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> ]