docgenerate

Overview ¶

Command docgenerate generates static documentation for Chain Core and the Chain Core SDKs.

Usage:

docgenerate chainPath outputDir

where chainPath is a path to your Chain repository, and outputDir is a target directory for the static files.

Before running docgenerate, ensure the following:

• The md2html command (also in this repo) is installed and up-to-date.
• Your historical version branches (e.g., 1.0-stable) are up-to-date. docgenerate uses these branches to generate SDK documentation, and will not fetch from a git remote.