Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
docs: show the sections in manual's chapters
authorMartin Quinson <martin.quinson@loria.fr>
Tue, 25 Sep 2018 07:36:48 +0000 (09:36 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Tue, 25 Sep 2018 07:36:48 +0000 (09:36 +0200)
Trick ahead: the sections are regular chapters, but with UTF
non-breaking spaces before their names to visually indent them a bit
in the sidebar.

The main page should now be changed because it looks ugly with that
trick. But the content had to be changed anyway, maybe replace with
the current content of the main webpage, that in turn should be
emptied of all letters to put nice pictures instead

docs/source/application.rst
docs/source/index.rst
docs/source/scenario.rst

index 4f0935e..b331ca0 100644 (file)
@@ -57,11 +57,3 @@ additional work.
 
 .. The old documentation of the obsolete MSG replay module was removed in
 ..  https://github.com/simgrid/simgrid/commit/e05361c201fb95d2b7605e59001cd0a49a489739
-
-.. toctree::
-   :hidden:
-
-      The S4U Interface <app_s4u.rst>
-      The SMPI Interface <app_smpi.rst>
-
-      
index 1cd37b7..45a6ed0 100644 (file)
@@ -3,6 +3,12 @@
 Welcome to SimGrid's documentation!
 ===================================
 
+.. 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.
+
 .. toctree::
    :maxdepth: 1
    :caption: Tutorials:
@@ -16,8 +22,11 @@ Welcome to SimGrid's documentation!
 
       Introduction <introduction.rst>
       Describing your Application <application.rst>
+         The S4U Interface <app_s4u.rst>
+         The SMPI Interface <app_smpi.rst>
       Describing the Virtual 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>
index 692f8c1..8d4b677 100644 (file)
@@ -12,10 +12,6 @@ Describing the Experimental Scenario
    - Reproducible random number generation
    - Command line options, in particular on the model switching
 
-.. toctree::
-   :hidden:
-
-      Configuring SimGrid <scenar_config.rst>