Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
include the full Java API doc in sphinx
[simgrid.git] / docs / source / index.rst
index 93d9c1a..3418071 100644 (file)
@@ -3,30 +3,48 @@
 Welcome to SimGrid's documentation!
 ===================================
 
-.. toctree::
-   :maxdepth: 1
-   :caption: Basic Use Cases:
+.. TODO
+..
+.. Change the content of this page to integrate the verbose content of the webpage. 
+.. The toctrees should be made hidden to only live as a sidebar.
+.. The webpage should be made light, graphical and nice looking.
 
-       Simulating Algorithms <tuto_s4u.rst>
-       Simulating MPI Apps <usecase_mpi.rst>
-   
 .. toctree::
    :maxdepth: 1
-   :caption: Getting Started:
+   :caption: Tutorials:
 
-       What is SimGrid <main_concepts.rst>
-       Installing SimGrid <installation.rst>
-       Start your Own Project <install_yours.rst>
+       Simulating Algorithms <tuto_s4u.rst>
+       Simulating MPI Applications <tuto_smpi.rst>
 
 .. toctree::
    :maxdepth: 2
-   :hidden:
-   :caption: API Reference:
-
-            API <api/library_root.rst>
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`
+   :caption: User Manual:
+
+      Introduction <introduction.rst>
+         Main Concepts <intro_concepts.rst>
+         Installing SimGrid <intro_install.rst>
+         Start your Own Project <intro_yours.rst>
+      Describing your Application <application.rst>
+         The S4U Interface <app_s4u.rst>
+         The SMPI Interface <app_smpi.rst>
+         The MSG Interface <app_msg.rst>
+         The Java Bindings <app_java.rst>
+      Describing the Simulated Platform <platform.rst>
+      Describing the Experimental Scenario <scenario.rst>
+         Configuring SimGrid <scenar_config.rst>
+      The SimGrid Models <models.rst>
+      Simulation Outcomes <outcomes.rst>
+      Use Cases and Howto <howto.rst>
+      The SimGrid Community <community.rst>
+      Frequently Asked Questions <faq.rst>
+
+
+
+.. Cheat Sheet on the sublevels
+..
+..   # with overline, for parts
+..   * with overline, for chapters
+..   =, for sections
+..   -, for subsections
+..   ^, for subsubsections
+..   ", for paragraphs