docs/source/index.rst

   1 .. SimGrid documentation master file
   2
   3 Welcome to SimGrid's documentation!
   4 ===================================
   5
   6 .. TODO
   7 ..
   8 .. Change the content of this page to integrate the verbose content of the webpage.
   9 .. The toctrees should be made hidden to only live as a sidebar.
  10 .. The webpage should be made light, graphical and nice looking.
  11
  12 .. toctree::
  13    :maxdepth: 1
  14    :caption: Tutorials:
  15
  16         Simulating Algorithms <tuto_s4u.rst>
  17         Simulating MPI Applications <tuto_smpi.rst>
  18
  19 .. toctree::
  20    :maxdepth: 2
  21    :caption: User Manual:
  22
  23       Introduction <introduction.rst>
  24       Describing your Application <application.rst>
  25          The S4U Interface <app_s4u.rst>
  26          The SMPI Interface <app_smpi.rst>
  27       Describing the Virtual Platform <platform.rst>
  28       Describing the Experimental Scenario <scenario.rst>
  29          Configuring SimGrid <scenar_config.rst>
  30       The SimGrid Models <models.rst>
  31       Simulation Outcomes <outcomes.rst>
  32       Use Cases and Howto <howto.rst>
  33       The SimGrid Community <community.rst>
  34       Frequently Asked Questions <faq.rst>
  35
  36 .. toctree::
  37    :maxdepth: 2
  38    :hidden:
  39    :caption: API Reference:
  40
  41              API <api/library_root.rst>
  42
  43 Indices and tables
  44 ==================
  45
  46 * :ref:`genindex`
  47 * :ref:`search`