diff options
| author |   Dan Klein <danklei@cisco.com> | 2015-10-12 08:59:01 +0300 |
|---|---|---|
| committer | Dan Klein <danklei@cisco.com> | 2015-10-12 08:59:20 +0300 |
| commit | 63318b05c360872ccd6d6348a6818ca2929927c9 (patch) | |
| tree | a3ad4a011f8431ace9686091d880d733391d50d8 /scripts/automation/trex_control_plane/doc | |
| parent | fba9663980d600d9c54c90f5ebd4afc346a007db (diff) | |
fixed documentation conflicts
Diffstat (limited to 'scripts/automation/trex_control_plane/doc')
3 files changed, 19 insertions, 33 deletions
diff --git a/scripts/automation/trex_control_plane/doc/about_trex.rst b/scripts/automation/trex_control_plane/doc/about_trex.rst deleted file mode 100755 index 669e2b28..00000000 --- a/scripts/automation/trex_control_plane/doc/about_trex.rst +++ /dev/null @@ -1,19 +0,0 @@ -================== -About TRex project -================== - -Full project's official site ----------------------------- - -To learn all about TRex project, visit TRex `official site <http://trex-tgn.cisco.com>`_ - -GitHub Repository ------------------ - -`TRex GitHub repository <https://github.com/cisco-system-traffic-generator>`_ - -TRex Google Group ------------------ - -Check out the project's `google group <https://groups.google.com/forum/#!forum/trex-tgn>`_ to contact TRex DEV team and follow other user stories. - diff --git a/scripts/automation/trex_control_plane/doc/api/index.rst b/scripts/automation/trex_control_plane/doc/api/index.rst new file mode 100755 index 00000000..6db45160 --- /dev/null +++ b/scripts/automation/trex_control_plane/doc/api/index.rst @@ -0,0 +1,19 @@ + +API Reference +============= +The T-Rex API reference section is currently a work in progress. + +**T-Rex Modules** + +.. toctree:: + :maxdepth: 4 + + client_code + exceptions + +**T-Rex JSON Template** + +.. toctree:: + :maxdepth: 4 + + json_fields
\ No newline at end of file diff --git a/scripts/automation/trex_control_plane/doc/index.rst b/scripts/automation/trex_control_plane/doc/index.rst index 10803cb0..62fd9975 100755 --- a/scripts/automation/trex_control_plane/doc/index.rst +++ b/scripts/automation/trex_control_plane/doc/index.rst @@ -18,13 +18,6 @@ To understand the entirely how the API works and how to set up the server side, **Use the table of contents below or the menu to your left to navigate through the site** -Getting Started -=============== -.. toctree:: - :maxdepth: 2 - - installation - API Reference ============= .. toctree:: @@ -46,13 +39,6 @@ Usage Examples usage_examples -About TRex -========== -.. toctree:: - :maxdepth: 2 - - All about TRex <about_trex> - Indices and tables ================== |