Skip to content

catalyst doc

Build a package's documentation.


catalyst doc [OPTIONS]


OPTIONS:
  -h,     --help              Print this help message and exit
  -e,     --engine TEXT       Override the documentation engine (doxygen, clang-doc, jocasta)
          --open              Open the generated documentation in the default browser upon
                              completion
          --clean             Clean the existing output directory before generation

Usage

catalyst doc [OPTIONS]

Options

  • -h, --help: Print help message