pkgs.gendocs

The Synapse pkgs.gendocs tool can be used to build Storm package documents from RStorm into markdown. This tool requires pandoc to be available.

Syntax

pkgs.gendocs is executed using python -m synapse.tools.pkgs.gendocs. The command usage is as follows:

python -m synapse.tools.pkgs.gendocs -h

usage: synapse.tools.pkgs.gendocs [-h] [--rst-only] <pkgfile>

A tool for building storm package docs from RStorm into markdown. This tool requires pandoc to be available.

positional arguments:
  <pkgfile>   Path to a storm package prototype yml file.

options:
  -h, --help  show this help message and exit
  --rst-only  Stops building after the .rst files have been generated.