diff options
Diffstat (limited to 'scripts/automation/trex_control_plane/doc/index.rst')
| -rwxr-xr-x | scripts/automation/trex_control_plane/doc/index.rst | 24 |
1 files changed, 17 insertions, 7 deletions
diff --git a/scripts/automation/trex_control_plane/doc/index.rst b/scripts/automation/trex_control_plane/doc/index.rst index dcaf9505..10803cb0 100755 --- a/scripts/automation/trex_control_plane/doc/index.rst +++ b/scripts/automation/trex_control_plane/doc/index.rst @@ -4,15 +4,15 @@ contain the root `toctree` directive. Welcome to TRex Control Plain's documentation! -=============================================== +============================================== -TRex 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 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 TRex 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** @@ -24,8 +24,6 @@ Getting Started :maxdepth: 2 installation - client_utils - usage_examples API Reference ============= @@ -34,14 +32,26 @@ API Reference api/index +Client Utilities +================ +.. toctree:: + :maxdepth: 2 + + client_utils + +Usage Examples +============== +.. toctree:: + :maxdepth: 2 + + usage_examples + About TRex ========== .. toctree:: :maxdepth: 2 All about TRex <about_trex> - license - Indices and tables |