doc/src/index.rst

   1
   2 .. include:: ../rst_prolog.rst
   3
   4 ************
   5 Salome Tools
   6 ************
   7
   8 .. note:: This documentation is under construction.
   9
  10 The **Sa**\ lome\ **T**\ ools (sat) is a suite of commands
  11 that can be used to perform operations on SALOME_.
  12
  13 For example, sat allows you to compile SALOME's codes
  14 (prerequisites, products)
  15 create application, run tests, create package, etc.
  16
  17 This utility code is a set of Python_ scripts files.
  18
  19
  20 Quick start
  21 ===========
  22
  23 .. toctree::
  24     :maxdepth: 1
  25
  26     Installation of salomeTools <installation_of_sat>
  27     Configuration <configuration>
  28     Usage of salomeTools <usage_of_sat>
  29
  30 List of Commands
  31 ================
  32
  33 .. toctree::
  34    :maxdepth: 1
  35
  36    config <commands/config>
  37    prepare <commands/prepare>
  38    compile <commands/compile>
  39    launcher <commands/launcher>
  40    application <commands/application>
  41    log <commands/log>
  42    environ <commands/environ>
  43    clean <commands/clean>
  44    package <commands/package>
  45
  46 Code documentation
  47 ==================
  48
  49 .. toctree::
  50    :maxdepth: 1
  51
  52    SAT modules <commands/apidoc/modules.rst>
  53
  54 Developer documentation
  55 =======================
  56
  57 .. toctree::
  58    :maxdepth: 1
  59
  60    Add a command <write_command>
  61
  62 Release Notes
  63 =============
  64
  65 .. toctree::
  66     :maxdepth: 1
  67
  68     Release Notes 5.0.0 <release_notes/release_notes_5.0.0>
  69