docs

Description

docs opens or reports HTML documentation for BLEND modules. By default it uses local HTML documentation when available and falls back to the BLEND documentation website. Use -Q to print the resolved documentation target without opening a viewer.

Usage

blend docs - Show HTML documentation for a BLEND module

usage: blend docs [-Q] [-S] [-V[q|e|w|t|i|c|d]] <module-name> [<-option>]

REQUIRED ARGUMENTS:

  <module-name>
     One of the BLEND modules, or one of api, examples, gallery, home,
     installation, options, polygons, quickstart, reference, website, and
     windows. Run blend --show-modules to list the available module names.

OPTIONAL ARGUMENTS:

  -Q
     Only display the documentation target and do not open it in a viewer.
     If given, -Q must be the first argument to blend docs.

  -S
     Use the BLEND documentation website instead of local documentation.

  <-option>
     The one-letter option of the module in question, for example -R.
     The documentation target is positioned at that option when available.

  -V[level], --verbose=<level>
     Select verbosity level [w]. Choose among q, e, w, t, i, c, and d:
       q  Quiet; suppress all diagnostic messages.
       e  Error messages only.
       w  Warnings and errors [Default].
       t  Timings, warnings, and errors.
       i  Informational messages, timings, warnings, and errors.
       c  Compatibility messages and all lower verbosity messages.
       d  Debug messages and all lower verbosity messages.

  -^ (or -)
     Print short synopsis message.

  -+ (or +)
     Print longer synopsis message.

  -? (or no arguments)
     Print this usage message.