diff options
| author |   Hanoh Haim <hhaim@cisco.com> | 2016-03-10 17:37:03 +0200 |
|---|---|---|
| committer | Hanoh Haim <hhaim@cisco.com> | 2016-03-10 17:37:03 +0200 |
| commit | 54fb838e24607af8532f725997b670f482abfe96 (patch) | |
| tree | e3249eb6ef7b41f36b8fe2ef37bec6554859f2ec /scripts/automation/trex_control_plane/doc_stl/api | |
| parent | 8ea0aeb8506b4da6b574700519ff4ca77b833c62 (diff) | |
first Stateless API doc
Diffstat (limited to 'scripts/automation/trex_control_plane/doc_stl/api')
| -rw-r--r-- | scripts/automation/trex_control_plane/doc_stl/api/client_code.rst | 17 | ||||
| -rw-r--r-- | scripts/automation/trex_control_plane/doc_stl/api/index.rst | 13 |
2 files changed, 30 insertions, 0 deletions
diff --git a/scripts/automation/trex_control_plane/doc_stl/api/client_code.rst b/scripts/automation/trex_control_plane/doc_stl/api/client_code.rst new file mode 100644 index 00000000..ef7feb61 --- /dev/null +++ b/scripts/automation/trex_control_plane/doc_stl/api/client_code.rst @@ -0,0 +1,17 @@ + +Module documentation +================================ + +STLClient class +----------------- + +.. autoclass:: trex_stl_lib.trex_stl_client.STLClient + :members: + +Stream class +----------------- + +.. automodule:: trex_stl_lib.trex_stl_streams + :members: + + diff --git a/scripts/automation/trex_control_plane/doc_stl/api/index.rst b/scripts/automation/trex_control_plane/doc_stl/api/index.rst new file mode 100644 index 00000000..4e4be230 --- /dev/null +++ b/scripts/automation/trex_control_plane/doc_stl/api/index.rst @@ -0,0 +1,13 @@ + +TRex Stateless API Reference +============================ + +**TRex Modules** + +.. toctree:: + :maxdepth: 4 + + client_code + +**TRex JSON Template** + |