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          Main Concepts <intro_concepts.rst>
  25          Installing SimGrid <intro_install.rst>
  26          Start your Own Project <intro_yours.rst>
  27       Describing your Application <application.rst>
  28          The S4U Interface <app_s4u.rst>
  29          The SMPI Interface <app_smpi.rst>
  30          The MSG Interface <app_msg.rst>
  31          The Java Bindings <app_java.rst>
  32       Describing the Simulated Platform <platform.rst>
  33          Examples <platform_examples.rst>
  34          Modeling Hints <platform_howtos.rst>
  35          DTD Reference <platform_reference.rst>
  36       Describing the Experimental Scenario <scenario.rst>
  37          Configuring SimGrid <scenar_config.rst>
  38       The SimGrid Models <models.rst>
  39       Simulation Outcomes <outcomes.rst>
  40       Use Cases and Howto <howto.rst>
  41       The SimGrid Community <community.rst>
  42       Frequently Asked Questions <faq.rst>
  43
  44
  45
  46 .. Cheat Sheet on the sublevels
  47 ..
  48 ..   # with overline, for parts
  49 ..   * with overline, for chapters
  50 ..   =, for sections
  51 ..   -, for subsections
  52 ..   ^, for subsubsections
  53 ..   ", for paragraphs