CoreFlows/gui/doc/index.rst

   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 .. _iraHome:
  11
  12 **************
  13 Solverlab GUI
  14 **************
  15
  16 .. image:: images/icon_about_SolverlabGUI.png
  17    :align: center
  18
  19 .. note:: Find *Solverlab code* documentation `here <SolverlabManualPdf_>`_ [1]_.
  20
  21 The Solverlab GUI code is a GUI_ (Graphical User Interface)
  22 used to perform simulations with `Solverlab physical models <SolverlabPresentationPdf_>`_.
  23
  24 The Solverlab GUI is designed with (Packagespy based on) PyQt5_ and Python3_ scripts files.
  25
  26
  27
  28 User's manual
  29 ==============
  30
  31 .. toctree::
  32    :maxdepth: 2
  33
  34    svlinstallation
  35    iramainwidget
  36    generaluse
  37    modelusage
  38
  39
  40
  41 Programmer's guide
  42 ====================
  43
  44 .. toctree::
  45    :maxdepth: 1
  46
  47    background
  48
  49 Packagespy
  50 ============
  51 (TODO packagespy doc)
  52
  53 .. toctree::
  54    :maxdepth: 1
  55
  56    packagespy
  57
  58
  59 Release Notes
  60 =============
  61
  62 .. toctree::
  63    :maxdepth: 1
  64
  65    Release Notes 9.8.0 <release_notes/release_notes_9.8.0>
  66
  67 .. [1] solverlabGUI/doc/src/solverlabDocuments/solverlab_manual.pdf