UNPKG

solidity-docgen

Version:

Solidity API documentation automatic generator.

29 lines (19 loc) • 884 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# `solidity-docgen` **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 :heart: by OpenZeppelin. ## Usage > **Note:** Detailed usage information is not available yet. Please be patient! ```sh 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> ] ``` [NatSpec]: https://solidity.readthedocs.io/en/develop/natspec-format.html