doc/src/index.rst

   1 ************
   2 SAlome Tools
   3 ************
   4
   5 .. note::
   6
   7     This documentation is under construction.
   8
   9 SAlomeTools (sat) is a suite of commands that can be used to perform operations on SALOME.
  10
  11 For example, sat allows you to compile SALOME's modules or prerequisites, create an application, run tests, create a package...
  12
  13 Quick start
  14 ===========
  15
  16 .. toctree::
  17     :maxdepth: 1
  18
  19     Installation of salomeTools (to be competed)
  20     Configuration (to be competed)
  21     Usage of salomeTools (to be competed)
  22
  23 List of Commands
  24 ================
  25
  26 .. toctree::
  27    :maxdepth: 1
  28
  29    config <commands/config>
  30    log <commands/log>
  31
  32 Code documentation
  33 ==================
  34
  35 .. toctree::
  36    :maxdepth: 1
  37
  38    SAT modules <commands/apidoc/modules.rst>
  39
  40 developer documentation
  41 =======================
  42
  43 .. toctree::
  44    :maxdepth: 1
  45
  46    Add a command <write_command>
  47
  48 Release Notes
  49 =============
  50 Here are the release notes for sat:
  51
  52 .. toctree::
  53     :maxdepth: 1
  54
  55     Release Notes 5.0.0 (to be completed)
  56