doc/build/html/_sources/index.rst.txt

   1
   2 .. include:: ../rst_prolog.rst
   3
   4 .. empty first toctree is used for pdf contents maxdepth, see sphinx/builders/latex/__init__.py, toctrees[0].get('maxdepth')
   5
   6 .. toctree::
   7    :maxdepth: 2
   8
   9 ************
  10 Salome Tools
  11 ************
  12
  13 .. image:: images/sat_about.png
  14    :scale: 100 %
  15    :align: center
  16
  17 .. warning:: This documentation is under construction.
  18
  19 The **Sa**\ lome\ **T**\ ools (sat) is a suite of commands
  20 that can be used to perform operations on SALOME_.
  21
  22 For example, sat allows you to compile SALOME's codes
  23 (prerequisites, products)
  24 create application, run tests, create package, etc.
  25
  26 This utility code is a set of Python_ scripts files.
  27
  28 Find a `pdf version of this documentation <SatPdf_>`_
  29
  30
  31 Quick start
  32 ===========
  33
  34 .. toctree::
  35    :maxdepth: 1
  36
  37    Installation of salomeTools <installation_of_sat>
  38    Configuration <configuration>
  39    Usage of salomeTools <usage_of_sat>
  40
  41 List of Commands
  42 ================
  43
  44 .. toctree::
  45    :maxdepth: 1
  46
  47    doc <commands/doc>
  48    config <commands/config>
  49    prepare <commands/prepare>
  50    compile <commands/compile>
  51    launcher <commands/launcher>
  52    application <commands/application>
  53    log <commands/log>
  54    environ <commands/environ>
  55    clean <commands/clean>
  56    package <commands/package>
  57    generate <commands/generate>
  58
  59 Developer documentation
  60 =======================
  61
  62 .. toctree::
  63    :maxdepth: 1
  64
  65    Add a command <write_command>
  66
  67
  68 Code documentation
  69 ==================
  70
  71 .. toctree::
  72    :maxdepth: 1
  73
  74    SAT modules <commands/apidoc/modules.rst>
  75
  76
  77 Release Notes
  78 =============
  79
  80 .. toctree::
  81    :maxdepth: 1
  82
  83    Release Notes 5.0.0 <release_notes/release_notes_5.0.0>
  84