docgenerate

command
v0.0.0-...-024a0a0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 16, 2017 License: AGPL-3.0 Imports: 11 Imported by: 0

Documentation

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL