os-ken/doc/source/library_packet_ref.rst
Hongbin Lu 52a227c309 Fixup the docs building
This commit enable users to run `tox -e docs` to build docs for os-ken.
It fixes several issues to ensure the build will succeed.
In addition, the docs from upstream Ryu library is grouped into
archived content. The future work is merging those docs into
the os-ken contents.

Change-Id: I5ee1998e0d2835495650cda530eb0b73c49b091a
2018-10-17 18:51:14 +00:00

28 lines
477 B
ReStructuredText

****************************
Packet library API Reference
****************************
Packet class
============
.. automodule:: os_ken.lib.packet.packet
:members:
Stream Parser class
===================
.. automodule:: os_ken.lib.packet.stream_parser
:members:
List of the sub-classes:
- :py:mod:`os_ken.lib.packet.bgp.StreamParser`
Protocol Header classes
=======================
.. toctree::
:glob:
library_packet_ref/packet_base
library_packet_ref/*