diff options
Diffstat (limited to 'scripts/automation/trex_control_plane/doc/index.rst')
| -rwxr-xr-x | scripts/automation/trex_control_plane/doc/index.rst | 34 |
1 files changed, 15 insertions, 19 deletions
diff --git a/scripts/automation/trex_control_plane/doc/index.rst b/scripts/automation/trex_control_plane/doc/index.rst index e7a619d8..62fd9975 100755 --- a/scripts/automation/trex_control_plane/doc/index.rst +++ b/scripts/automation/trex_control_plane/doc/index.rst @@ -1,32 +1,23 @@ -.. T-Rex Control Plain documentation master file, created by +.. TRex 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! -=============================================== +Welcome to TRex Control Plain's documentation! +============================================== -T-Rex is a **realistic traffic generator** that enables you to do get learn more about your under developement devices. +TRex is a **realistic traffic generator** that enables you to do get learn more about your under development devices. -This site covers the Python API of T-Rex control plane, and explains how to utilize it to your needs. +This site covers the Python API of TRex 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. +To 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. **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:: @@ -34,14 +25,19 @@ API Reference api/index -About T-Rex -=========== +Client Utilities +================ .. toctree:: :maxdepth: 2 - All about T-Rex <about_trex> - license + client_utils +Usage Examples +============== +.. toctree:: + :maxdepth: 2 + + usage_examples Indices and tables |