cec doc

Generate documentation of the Cells Client

Synopsis

This command automatically generates the documentation of the Cells Client. It produces nice Markdown files based on the various comments that are in the code itself.

Please, provide the '-p' flag with a path to define where to put the generated files.

Also note that this command also generates the yaml files that we use for pydio.com documentation format.

./cec doc [flags]

Options

  -h, --help          help for doc
  -m, --menu string   Pydio Docs menu name (default "menu-admin-guide-v7")
  -p, --path string   Target folder where to put the files

Options inherited from parent commands

  -c, --config string   Path to the configuration file

SEE ALSO

  • ./cec - Connect to a Pydio Cells server using the command line
Auto generated by Cells Client v2.0.0 on 16-Dec-2019
Back to top