From 45b39212faf07b4b58f6e9c31f8aa5bd4e52427c Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sun, 30 Jun 2019 12:22:41 +0200 Subject: [PATCH] doc: Better uniformity wrt graphical toc --- docs/source/Experimental_Setup.rst | 29 +++ docs/source/app_s4u.rst | 4 +- docs/source/app_smpi.rst | 1 + docs/source/img/graphical-toc.svg | 352 ++++++++++++++++------------- docs/source/index.rst | 2 +- docs/source/platform.rst | 5 - docs/source/scenario.rst | 17 -- tools/cmake/DefinePackages.cmake | 4 +- 8 files changed, 228 insertions(+), 186 deletions(-) create mode 100644 docs/source/Experimental_Setup.rst delete mode 100644 docs/source/scenario.rst diff --git a/docs/source/Experimental_Setup.rst b/docs/source/Experimental_Setup.rst new file mode 100644 index 0000000000..280b80921a --- /dev/null +++ b/docs/source/Experimental_Setup.rst @@ -0,0 +1,29 @@ +.. _scenario: + +.. raw:: html + + + +
+
+ +Describing the Experimental Setup +********************************* + +.. todo:: + + Main concepts: + + - Deployment file + - Availability and state profiles + - Reproducible random number generation + - Command line options, in particular on the model switching + + + + diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index 43afc8e08b..5bfdc53795 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -8,8 +8,8 @@ The S4U Interface
diff --git a/docs/source/app_smpi.rst b/docs/source/app_smpi.rst index 048413c7ba..31e8b43a8b 100644 --- a/docs/source/app_smpi.rst +++ b/docs/source/app_smpi.rst @@ -11,6 +11,7 @@ SMPI: Simulate MPI Applications window.onload=function() { // Wait for the SVG to be loaded before changing it var elem=document.querySelector("#TOC").contentDocument.getElementById("SMPIBox") elem.style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1"; + elem.style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"; }
diff --git a/docs/source/img/graphical-toc.svg b/docs/source/img/graphical-toc.svg index 00093bffd5..2ea55419d0 100644 --- a/docs/source/img/graphical-toc.svg +++ b/docs/source/img/graphical-toc.svg @@ -25,8 +25,8 @@ inkscape:pageopacity="0.0" inkscape:pageshadow="2" inkscape:zoom="2.8" - inkscape:cx="260.34874" - inkscape:cy="201.73977" + inkscape:cx="221.05408" + inkscape:cy="26.288995" inkscape:document-units="mm" inkscape:current-layer="layer1" showgrid="true" @@ -45,7 +45,7 @@ @@ -2300,7 +2300,7 @@ image/svg+xml - + @@ -2312,15 +2312,15 @@ style="display:inline"> + inkscape:label="PlatformLink"> @@ -2344,9 +2344,10 @@ + id="a6097"> Dynamic profiles - + + ExperimentalSetup + id="text818" + inkscape:label="XPSetupText">ExperimentalSetup + Reduction - + id="a6242" + inkscape:label="ApplicationLink"> - Application - - + inkscape:label="ApplicationBox" /> (what you test) - - ▸ Abstract Actors - + id="text814" + y="71.701172" + x="8.285965" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.76111126px;line-height:6.61458302px;font-family:'Bitstream Vera Sans';-inkscape-font-specification:'Bitstream Vera Sans';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + xml:space="preserve" + inkscape:label="ApplicationText1">Application - ▸ MPI Legacy Code - ▸ Offline Traces - ▸ Centralized Algo + transform="matrix(0.0830545,0,0,-0.0830545,77.484414,170.53818)" + inkscape:label="g34108" /> @@ -6256,13 +6200,13 @@ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.29166698px;font-family:'Bitstream Vera Sans';-inkscape-font-specification:'Bitstream Vera Sans';stroke-width:0.26458332px">Calibration + id="a6149" + transform="translate(-0.52916951,14.28751)"> + id="a6179"> - - - - + - Manual + inkscape:label="PlatfRoutingLink"> paths + + + Abstract Actors + + + + Offline Traces + + + + MPI Legacy Code + + + + + + diff --git a/docs/source/index.rst b/docs/source/index.rst index e5a01946a3..8cecc8de8f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -76,7 +76,7 @@ of every page. Bugs in the code should be reported Describing the Simulated Platform    Modeling Hints    DTD Reference - Describing the Experimental Scenario + Describing the Experimental Scenario    Configuring SimGrid The SimGrid Models    ns-3 as a SimGrid model diff --git a/docs/source/platform.rst b/docs/source/platform.rst index b8286bef04..aa2574749c 100644 --- a/docs/source/platform.rst +++ b/docs/source/platform.rst @@ -7,11 +7,6 @@ window.onload=function() { // Wait for the SVG to be loaded before changing it var elem=document.querySelector("#TOC").contentDocument.getElementById("PlatformBox") elem.style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"; - - for (name of ["RoutingBox", "ProfileBox"]) { - var elem=document.querySelector("#TOC").contentDocument.getElementById(name) - elem.style="fill-opacity:0;opacity:0.93999999;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"; - } }
diff --git a/docs/source/scenario.rst b/docs/source/scenario.rst deleted file mode 100644 index 8d4b67774c..0000000000 --- a/docs/source/scenario.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _scenario: - -Describing the Experimental Scenario -************************************ - -.. todo:: - - Main concepts: - - - Deployment file - - Availability and state profiles - - Reproducible random number generation - - Command line options, in particular on the model switching - - - - diff --git a/tools/cmake/DefinePackages.cmake b/tools/cmake/DefinePackages.cmake index ad836e8e46..bce03f548a 100644 --- a/tools/cmake/DefinePackages.cmake +++ b/tools/cmake/DefinePackages.cmake @@ -885,6 +885,8 @@ set(DOC_SOURCES docs/source/app_s4u.rst docs/source/app_smpi.rst docs/source/community.rst + docs/source/Configuring_SimGrid.rst + docs/source/Experimental_Setup.rst docs/source/index.rst docs/source/Introduction.rst docs/source/Installing_SimGrid.rst @@ -895,8 +897,6 @@ set(DOC_SOURCES docs/source/platform.rst docs/source/platform_howtos.rst docs/source/platform_reference.rst - docs/source/Configuring_SimGrid.rst - docs/source/scenario.rst docs/source/Tutorial_Algorithms.rst docs/source/tuto_s4u/deployment1.xml -- 2.20.1