diff options
Diffstat (limited to 'scripts/automation/trex_control_plane/doc/index.rst')
-rwxr-xr-x | scripts/automation/trex_control_plane/doc/index.rst | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/scripts/automation/trex_control_plane/doc/index.rst b/scripts/automation/trex_control_plane/doc/index.rst new file mode 100755 index 00000000..e7a619d8 --- /dev/null +++ b/scripts/automation/trex_control_plane/doc/index.rst @@ -0,0 +1,57 @@ +.. T-Rex Control Plain documentation master file, created by + sphinx-quickstart on Tue Jun 2 07:48:10 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to T-Rex Control Plain's documentation! +=============================================== + +T-Rex is a **realistic traffic generator** that enables you to do get learn more about your under developement devices. + +This site covers the Python API of T-Rex control plane, and explains how to utilize it to your needs. +However, since the entire API is JSON-RPC [#f1]_ based, you may want to check out other implementations that could suit you. + + +To understand the entirely how the API works and how to set up the server side, check out the `API documentation <http://csi-wiki-01:8080/display/bpsim/Documentation>`_ undee the documentation section of T-Rex website. + + +**Use the table of contents below or the menu to your left to navigate through the site** + + +Getting Started +=============== +.. toctree:: + :maxdepth: 2 + + installation + client_utils + usage_examples + +API Reference +============= +.. toctree:: + :maxdepth: 2 + + api/index + +About T-Rex +=========== +.. toctree:: + :maxdepth: 2 + + All about T-Rex <about_trex> + license + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. rubric:: Footnotes + +.. [#f1] For more information on JSON-RPC, check out the `official site <http://www.jsonrpc.org/>`_
\ No newline at end of file |