index.rst revision 33386099
1.. TRex Stateless Python API documentation 
2   contain the root `toctree` directive.
3
4TRex Stateless Python API
5==============================================
6
7TRex is a **traffic generator** 
8
9This site covers the Python API of TRex and explains how to utilize it to your needs.
10To understand the entirely how the API works and how to set up the server side, check out the `trex-core Wiki <https://github.com/cisco-system-traffic-generator/trex-core/wiki>`_ under the documentation section of TRex website.
11   
12**Use the table of contents below or the menu to your left to navigate through the site**
13
14How to Install 
15=============
16.. toctree::
17    :maxdepth: 2
18
19* TODO[]
20        
21
22API Reference
23=============
24.. toctree::
25    :maxdepth: 2
26
27    api/index
28
29Indices and tables
30==================
31
32* :ref:`genindex`
33* :ref:`modindex`
34* :ref:`search`
35
36
37.. rubric:: Footnotes
38
39