doc/src/commands/doc.rst

   1
   2 .. include:: ../../rst_prolog.rst
   3
   4 Command doc
   5 ****************
   6
   7 Description
   8 ===========
   9 The **doc** command displays sat documentation.
  10
  11 Usage
  12 =====
  13 * Show (in a web browser) the sat documentation: ::
  14
  15     sat doc --html
  16
  17 * Show (in evince, for example) the (same) sat documentation in format pdf: ::
  18
  19     sat doc --pdf
  20
  21 * Edit and modify in your preference user editor the sources files (rst) of sat documentation: ::
  22
  23     sat doc --edit
  24
  25 * get information how to compile locally sat documentation (from the sources files): ::
  26
  27     sat doc --compile
  28
  29
  30
  31 Some useful configuration pathes
  32 =================================
  33
  34 * **USER**
  35
  36   * **browser** : The browser used to show the html files (*firefox* for example).
  37   * **pdf_viewer** : The viewer used to show the pdf files (*evince* for example).
  38   * **editor** : The editor used to edit ascii text files (*pluma or gedit* for example).
  39