Mininet api documentation

lantz edited this page Oct 17, 2015 · 8 revisions

Mininet's modules and Python API are documented using Python documentation strings which may be accessed from Python's regular help() mechanism. For example,

python
>>> from mininet.node import Host
>>> help(Host.IP)
Help on method IP in module mininet.node:
IP(self, intf=None) unbound mininet.node.Host method
        Return IP address of a node or specific interface.</verbatim>

You may also wish to generate HTML (and PDF) documentation using doxypy:

sudo apt-get install doxypy help2man texlive texlive-latex-extra
cd ~/mininet
make doc

For your convenience, we've already done this for you and uploaded the HTML to http://api.mininet.org.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.