build command

Build configured documentation outputs

Syntax

console
$ docinsight build --help
Build configured documentation outputs

Usage: docinsight build [OPTIONS]

Options:
  -h, --help
          Print help

Project Options:
      --manifest <PATH>
          Path to a `docinsight.json` or legacy `.diproj` manifest

Target Selection:
  -t, --target <NAME[=PATH]>
          Select a target; append `=PATH` to override its output

      --all-targets
          Select all output targets, ignoring `output.default_targets`

  -f, --format <FMT>
          Select output targets by format

          [possible values: html, chm]

Build Options:
  -j, --jobs <N>
          Number of parallel jobs; defaults to the number of available CPUs, up to 16

          [env: DOCINSIGHT_JOBS=]

      --dry-run
          Simulate the building process without producing output files

      --verify-output
          Hash reusable destination files and rewrite any whose content differs

      --open
          Open the built output when finished

Output Options:
  -q, --quiet
          Suppress all messages except for warnings and errors

  -v, --verbose...
          Increase output detail (-v for verbose, -vv for full operational details)

Terminal Options:
      --color <WHEN>
          When to use terminal colors

          [possible values: auto, always, never]

      --no-color
          Disable terminal colors

      --progress <WHEN>
          When to display progress indicators

          [possible values: auto, always, never]

      --no-progress
          Disable progress indicators

      --hyperlinks <WHEN>
          When to emit terminal hyperlinks

          [possible values: auto, always, never]

      --no-hyperlinks
          Disable terminal hyperlinks

Interaction Options:
      --no-input
          Never prompt for user input

Logging Options:
      --log-file <PATH>
          Write diagnostic logs to a file

          [env: DOCINSIGHT_LOG_FILE=]

      --log-level <LEVEL>
          Set the minimum diagnostic log level

          [env: DOCINSIGHT_LOG_LEVEL=]
          [possible values: error, warn, info, debug, trace]