move the README.rst in examples/ as it also describes python

diff --git a/MANIFEST.in b/MANIFEST.in
index 9f533c4..dc77952 100644 (file)
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -273,7 +273,6 @@ include examples/python/exec-dvfs/exec-dvfs.py
 include examples/python/exec-dvfs/exec-dvfs.tesh
 include examples/python/exec-remote/exec-remote.py
 include examples/python/exec-remote/exec-remote.tesh
 include examples/python/exec-dvfs/exec-dvfs.tesh
 include examples/python/exec-remote/exec-remote.py
 include examples/python/exec-remote/exec-remote.tesh

-include examples/s4u/README.rst

 include examples/s4u/actor-create/s4u-actor-create.cpp
 include examples/s4u/actor-create/s4u-actor-create.tesh
 include examples/s4u/actor-create/s4u-actor-create_d.xml
 include examples/s4u/actor-create/s4u-actor-create.cpp
 include examples/s4u/actor-create/s4u-actor-create.tesh
 include examples/s4u/actor-create/s4u-actor-create_d.xml


@@ -1768,6 +1767,7 @@ include docs/source/Tutorial_Algorithms.rst
 include docs/source/Tutorial_MPI_Applications.rst
 include docs/source/XML_Reference.rst
 include docs/source/_ext/hidden_code_block.py
 include docs/source/Tutorial_MPI_Applications.rst
 include docs/source/XML_Reference.rst
 include docs/source/_ext/hidden_code_block.py

+include docs/source/_ext/showfile.py

 include docs/source/_templates/breadcrumbs.html
 include docs/source/app_msg.rst
 include docs/source/app_s4u.rst
 include docs/source/_templates/breadcrumbs.html
 include docs/source/app_msg.rst
 include docs/source/app_s4u.rst


@@ -1779,8 +1779,6 @@ include docs/source/img/eclipseScreenShot.png
 include docs/source/img/extlink.png
 include docs/source/img/extlink.svg
 include docs/source/img/graphical-toc.svg
 include docs/source/img/extlink.png
 include docs/source/img/extlink.svg
 include docs/source/img/graphical-toc.svg

-include docs/source/img/lang_cpp.png
-include docs/source/img/lang_python.png

 include docs/source/img/smpi_simgrid_alltoall_pair_16.png
 include docs/source/img/smpi_simgrid_alltoall_ring_16.png
 include docs/source/img/zone_hierarchy.png
 include docs/source/img/smpi_simgrid_alltoall_pair_16.png
 include docs/source/img/smpi_simgrid_alltoall_ring_16.png
 include docs/source/img/zone_hierarchy.png


@@ -1810,6 +1808,7 @@ include docs/source/tuto_smpi/gemm_mpi.cpp
 include docs/source/tuto_smpi/img/big-picture.svg
 include docs/source/tuto_smpi/img/lu.S.4.png
 include docs/source/tuto_smpi/roundtrip.c
 include docs/source/tuto_smpi/img/big-picture.svg
 include docs/source/tuto_smpi/img/lu.S.4.png
 include docs/source/tuto_smpi/roundtrip.c

+include examples/README.rst

 include examples/deprecated/java/.classpath
 include examples/deprecated/java/.project
 include examples/deprecated/java/CMakeLists.txt
 include examples/deprecated/java/.classpath
 include examples/deprecated/java/.project
 include examples/deprecated/java/CMakeLists.txt

diff --git a/docs/Build.sh b/docs/Build.sh
index 5f9cd83..fcfcd69 100755 (executable)
--- a/docs/Build.sh
+++ b/docs/Build.sh
@@ -71,9 +71,9 @@ done
 
 echo "Undocumented examples:"
 for ex in `(cd .. ; find examples/s4u/ -name '*.cpp'; find examples/python -name '*.py')|sort` ; do
 
 echo "Undocumented examples:"
 for ex in `(cd .. ; find examples/s4u/ -name '*.cpp'; find examples/python -name '*.py')|sort` ; do

-    if grep -q "example-tab:: $ex" ../examples/s4u/README.rst ; then :
+    if grep -q "example-tab:: $ex" ../examples/README.rst ; then :

 #        echo "found example-tab:: $ex"
 #        echo "found example-tab:: $ex"

-    elif grep -q "showfile:: $ex" ../examples/s4u/README.rst ; then :
+    elif grep -q "showfile:: $ex" ../examples/README.rst ; then :

     else
         echo $ex
     fi
     else
         echo $ex
     fi

diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst
index e422a70..fd8bc9a 100644 (file)
--- a/docs/source/app_s4u.rst
+++ b/docs/source/app_s4u.rst
@@ -138,10 +138,6 @@ provides many helper functions to simplify the code of actors.
 
 .. |API_s4u_Mutex| replace:: **Mutex**
 
 
 .. |API_s4u_Mutex| replace:: **Mutex**
 

-.. THE EXAMPLES
-
-.. include:: ../../examples/s4u/README.rst
-

 Activities
 **********
 
 Activities
 **********
 


@@ -369,6 +365,10 @@ pointers (yet?). This means that it is currently impossible to destroy a
 mailbox or a link. You can still destroy an host (but probably
 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 
 mailbox or a link. You can still destroy an host (but probably
 shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`.
 

+.. THE EXAMPLES
+
+.. include:: ../../examples/README.rst
+

 C++ API Reference
 *****************
 
 C++ API Reference
 *****************
 

diff --git a/examples/s4u/README.rst b/examples/README.rst
similarity index 100%
rename from examples/s4u/README.rst
rename to examples/README.rst

diff --git a/examples/s4u/CMakeLists.txt b/examples/s4u/CMakeLists.txt
index 034f340..29ecf4f 100644 (file)
--- a/examples/s4u/CMakeLists.txt
+++ b/examples/s4u/CMakeLists.txt
@@ -187,6 +187,5 @@ set(bin_files     ${bin_files}    ${CMAKE_CURRENT_SOURCE_DIR}/dht-kademlia/gener
 set(txt_files     ${txt_files}    ${CMAKE_CURRENT_SOURCE_DIR}/replay-comm/s4u-replay-comm-split-p0.txt
                                   ${CMAKE_CURRENT_SOURCE_DIR}/replay-comm/s4u-replay-comm-split-p1.txt
                                   ${CMAKE_CURRENT_SOURCE_DIR}/replay-comm/s4u-replay-comm.txt
 set(txt_files     ${txt_files}    ${CMAKE_CURRENT_SOURCE_DIR}/replay-comm/s4u-replay-comm-split-p0.txt
                                   ${CMAKE_CURRENT_SOURCE_DIR}/replay-comm/s4u-replay-comm-split-p1.txt
                                   ${CMAKE_CURRENT_SOURCE_DIR}/replay-comm/s4u-replay-comm.txt

-                                  ${CMAKE_CURRENT_SOURCE_DIR}/replay-io/s4u-replay-io.txt
-                                  ${CMAKE_CURRENT_SOURCE_DIR}/README.rst                                   PARENT_SCOPE)
+                                  ${CMAKE_CURRENT_SOURCE_DIR}/replay-io/s4u-replay-io.txt                  PARENT_SCOPE)

 
 

diff --git a/tools/cmake/DefinePackages.cmake b/tools/cmake/DefinePackages.cmake
index c4beedb..7014a43 100644 (file)
--- a/tools/cmake/DefinePackages.cmake
+++ b/tools/cmake/DefinePackages.cmake
@@ -862,6 +862,8 @@ set(DOC_SOURCES
   doc/doxygen/uhood_switch.doc
   doc/doxygen/uhood_arch.doc
 
   doc/doxygen/uhood_switch.doc
   doc/doxygen/uhood_arch.doc
 

+  examples/README.rst
+

   docs/manpages/smpicc.1
   docs/manpages/smpicxx.1
   docs/manpages/smpif90.1
   docs/manpages/smpicc.1
   docs/manpages/smpicxx.1
   docs/manpages/smpif90.1