publish-sphinx

Introduction

Generates documentation for the model including embedded graphs of each Item type and Composite type using the publish-dot command.

Requires that dotnet, Graphviz and Sphinx are installed.

Command Line Arguments

Required inputs for the publish-sphinx command (must be specified in order).

• [CogsLocation]

  The location of the folder containing the model.

• [TargetLocation]

  The location of the folder where the output will be created.

Command Line Flags

Optional inputs for the publish-sphinx command.

• -?|-h|--help

  Displays all possible command arguments and flags for the publish-sphinx command.

• -o|--overwrite

  If the [TargetLocation] is not empty, erase all files in the folder before generation.

• -l|--location

  Directory where the dot.exe file is located–only needed if not running on Windows.

Command Line Usage

Format

$ publish-sphinx (-h) (-o) (-l [location]) [CogsLocation] [TargetLocation]

Examples

A few examples of how the command line arguments and flags can be used together.

$ publish-sphinx -h
$ publish-sphinx MyCogsModelDirectory MyOutputDirectory
$ publish-sphinx -o MyCogsModelDirectory MyOutputDirectory
$ publish-sphinx -o -l MyGraphvizDotDirectory MyCogsModelDirectory MyOutputDirectory