doc cosmetics, and cleanup the API

[simgrid.git] / docs / source / app_s4u.rst

diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst
index c4dbd41..3f3aaec 100644 (file)
--- a/docs/source/app_s4u.rst
+++ b/docs/source/app_s4u.rst
@@ -300,7 +300,7 @@ balancing for free if more than one actor pulls from the mailbox:
 the first actor that can deal with the request will handle it.
 
 =========================================
 the first actor that can deal with the request will handle it.
 
 =========================================

-How put() and get() Requests are Matched?
+How are put() and get() requests matched?

 =========================================
 
 The matching algorithm simple: first come, first serve. When a new
 =========================================
 
 The matching algorithm simple: first come, first serve. When a new


@@ -317,7 +317,7 @@ Declaring a Receiving Actor
 
 The last twist is that by default in the simulator, the data starts
 to be exchanged only when both the sender and the receiver are
 
 The last twist is that by default in the simulator, the data starts
 to be exchanged only when both the sender and the receiver are

-declared (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`
+announced (it waits until both :cpp:func:`put() <simgrid::s4u::Mailbox::put()>`

 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted). 
 In TCP, since you establish connexions beforehand, the data starts to
 flow as soon as the sender posts it, even if the receiver did not post
 and :cpp:func:`get() <simgrid::s4u::Mailbox::get()>` are posted). 
 In TCP, since you establish connexions beforehand, the data starts to
 flow as soon as the sender posts it, even if the receiver did not post


@@ -365,8 +365,8 @@ Here is a little example:
   
    } // The mutex gets automatically freed because the only existing reference gets out of scope
 
   
    } // The mutex gets automatically freed because the only existing reference gets out of scope
 

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

 
 .. _API_s4u_this_actor:
 
 
 .. _API_s4u_this_actor:
 


@@ -573,3 +573,44 @@ s4u::VirtualMachine
    :protected-members:
    :undoc-members:
 
    :protected-members:
    :undoc-members:
 

+
+Python API Reference
+********************
+
+The Python API is generated with pybind11. It closely mimicks the C++
+API, to which you should refer for more information.
+
+==========
+this_actor
+==========
+
+.. automodule:: simgrid.this_actor
+   :members:
+
+===========
+Class Actor
+===========
+
+.. autoclass:: simgrid.Actor
+   :members:
+
+============
+Class Engine
+============
+
+.. autoclass:: simgrid.Engine
+   :members:
+
+==========
+Class Host
+==========
+
+.. autoclass:: simgrid.Host
+   :members:
+
+=============
+Class Mailbox
+=============
+
+.. autoclass:: simgrid.Mailbox
+   :members: