From 7532c9ae4cfd36a57025a14aadc9125725f5ab7c Mon Sep 17 00:00:00 2001 From: Brian Wylie <bwylie@vectranetworks.com> Date: Tue, 19 May 2015 09:50:55 -0600 Subject: [PATCH] auto generating the api docs --- docs/api/api_auto.rst | 545 ++++++++++++++++++++++++++++++++++++++++++ docs/api/ethernet.rst | 9 - docs/api/http.rst | 15 -- docs/api/index.rst | 8 +- docs/api/ip.rst | 9 - docs/api/tcp.rst | 9 - docs/api/udp.rst | 9 - docs/index.rst | 13 +- 8 files changed, 553 insertions(+), 64 deletions(-) create mode 100644 docs/api/api_auto.rst delete mode 100644 docs/api/ethernet.rst delete mode 100644 docs/api/http.rst delete mode 100644 docs/api/ip.rst delete mode 100644 docs/api/tcp.rst delete mode 100644 docs/api/udp.rst diff --git a/docs/api/api_auto.rst b/docs/api/api_auto.rst new file mode 100644 index 0000000..3837c90 --- /dev/null +++ b/docs/api/api_auto.rst @@ -0,0 +1,545 @@ + +dpkt.ah module +-------------- + +.. automodule:: dpkt.ah + :members: + :undoc-members: + :show-inheritance: + +dpkt.aim module +--------------- + +.. automodule:: dpkt.aim + :members: + :undoc-members: + :show-inheritance: + +dpkt.aoe module +--------------- + +.. automodule:: dpkt.aoe + :members: + :undoc-members: + :show-inheritance: + +dpkt.aoeata module +------------------ + +.. automodule:: dpkt.aoeata + :members: + :undoc-members: + :show-inheritance: + +dpkt.aoecfg module +------------------ + +.. automodule:: dpkt.aoecfg + :members: + :undoc-members: + :show-inheritance: + +dpkt.arp module +--------------- + +.. automodule:: dpkt.arp + :members: + :undoc-members: + :show-inheritance: + +dpkt.asn1 module +---------------- + +.. automodule:: dpkt.asn1 + :members: + :undoc-members: + :show-inheritance: + +dpkt.bgp module +--------------- + +.. automodule:: dpkt.bgp + :members: + :undoc-members: + :show-inheritance: + +dpkt.cdp module +--------------- + +.. automodule:: dpkt.cdp + :members: + :undoc-members: + :show-inheritance: + +dpkt.crc32c module +------------------ + +.. automodule:: dpkt.crc32c + :members: + :undoc-members: + :show-inheritance: + +dpkt.decorators module +---------------------- + +.. automodule:: dpkt.decorators + :members: + :undoc-members: + :show-inheritance: + +dpkt.dhcp module +---------------- + +.. automodule:: dpkt.dhcp + :members: + :undoc-members: + :show-inheritance: + +dpkt.diameter module +-------------------- + +.. automodule:: dpkt.diameter + :members: + :undoc-members: + :show-inheritance: + +dpkt.dns module +--------------- + +.. automodule:: dpkt.dns + :members: + :undoc-members: + :show-inheritance: + +dpkt.dpkt module +---------------- + +.. automodule:: dpkt.dpkt + :members: + :undoc-members: + :show-inheritance: + +dpkt.dtp module +--------------- + +.. automodule:: dpkt.dtp + :members: + :undoc-members: + :show-inheritance: + +dpkt.esp module +--------------- + +.. automodule:: dpkt.esp + :members: + :undoc-members: + :show-inheritance: + +dpkt.ethernet module +-------------------- + +.. automodule:: dpkt.ethernet + :members: + :undoc-members: + :show-inheritance: + +dpkt.gre module +--------------- + +.. automodule:: dpkt.gre + :members: + :undoc-members: + :show-inheritance: + +dpkt.gzip module +---------------- + +.. automodule:: dpkt.gzip + :members: + :undoc-members: + :show-inheritance: + +dpkt.h225 module +---------------- + +.. automodule:: dpkt.h225 + :members: + :undoc-members: + :show-inheritance: + +dpkt.hsrp module +---------------- + +.. automodule:: dpkt.hsrp + :members: + :undoc-members: + :show-inheritance: + +dpkt.http module +---------------- + +.. automodule:: dpkt.http + :members: + :undoc-members: + :show-inheritance: + +dpkt.icmp module +---------------- + +.. automodule:: dpkt.icmp + :members: + :undoc-members: + :show-inheritance: + +dpkt.icmp6 module +----------------- + +.. automodule:: dpkt.icmp6 + :members: + :undoc-members: + :show-inheritance: + +dpkt.ieee80211 module +--------------------- + +.. automodule:: dpkt.ieee80211 + :members: + :undoc-members: + :show-inheritance: + +dpkt.igmp module +---------------- + +.. automodule:: dpkt.igmp + :members: + :undoc-members: + :show-inheritance: + +dpkt.ip module +-------------- + +.. automodule:: dpkt.ip + :members: + :undoc-members: + :show-inheritance: + +dpkt.ip6 module +--------------- + +.. automodule:: dpkt.ip6 + :members: + :undoc-members: + :show-inheritance: + +dpkt.ipx module +--------------- + +.. automodule:: dpkt.ipx + :members: + :undoc-members: + :show-inheritance: + +dpkt.llc module +--------------- + +.. automodule:: dpkt.llc + :members: + :undoc-members: + :show-inheritance: + +dpkt.loopback module +-------------------- + +.. automodule:: dpkt.loopback + :members: + :undoc-members: + :show-inheritance: + +dpkt.mrt module +--------------- + +.. automodule:: dpkt.mrt + :members: + :undoc-members: + :show-inheritance: + +dpkt.netbios module +------------------- + +.. automodule:: dpkt.netbios + :members: + :undoc-members: + :show-inheritance: + +dpkt.netflow module +------------------- + +.. automodule:: dpkt.netflow + :members: + :undoc-members: + :show-inheritance: + +dpkt.ntp module +--------------- + +.. automodule:: dpkt.ntp + :members: + :undoc-members: + :show-inheritance: + +dpkt.ospf module +---------------- + +.. automodule:: dpkt.ospf + :members: + :undoc-members: + :show-inheritance: + +dpkt.pcap module +---------------- + +.. automodule:: dpkt.pcap + :members: + :undoc-members: + :show-inheritance: + +dpkt.pim module +--------------- + +.. automodule:: dpkt.pim + :members: + :undoc-members: + :show-inheritance: + +dpkt.pmap module +---------------- + +.. automodule:: dpkt.pmap + :members: + :undoc-members: + :show-inheritance: + +dpkt.ppp module +--------------- + +.. automodule:: dpkt.ppp + :members: + :undoc-members: + :show-inheritance: + +dpkt.pppoe module +----------------- + +.. automodule:: dpkt.pppoe + :members: + :undoc-members: + :show-inheritance: + +dpkt.qq module +-------------- + +.. automodule:: dpkt.qq + :members: + :undoc-members: + :show-inheritance: + +dpkt.radiotap module +-------------------- + +.. automodule:: dpkt.radiotap + :members: + :undoc-members: + :show-inheritance: + +dpkt.radius module +------------------ + +.. automodule:: dpkt.radius + :members: + :undoc-members: + :show-inheritance: + +dpkt.rfb module +--------------- + +.. automodule:: dpkt.rfb + :members: + :undoc-members: + :show-inheritance: + +dpkt.rip module +--------------- + +.. automodule:: dpkt.rip + :members: + :undoc-members: + :show-inheritance: + +dpkt.rpc module +--------------- + +.. automodule:: dpkt.rpc + :members: + :undoc-members: + :show-inheritance: + +dpkt.rtp module +--------------- + +.. automodule:: dpkt.rtp + :members: + :undoc-members: + :show-inheritance: + +dpkt.rx module +-------------- + +.. automodule:: dpkt.rx + :members: + :undoc-members: + :show-inheritance: + +dpkt.sccp module +---------------- + +.. automodule:: dpkt.sccp + :members: + :undoc-members: + :show-inheritance: + +dpkt.sctp module +---------------- + +.. automodule:: dpkt.sctp + :members: + :undoc-members: + :show-inheritance: + +dpkt.sip module +--------------- + +.. automodule:: dpkt.sip + :members: + :undoc-members: + :show-inheritance: + +dpkt.sll module +--------------- + +.. automodule:: dpkt.sll + :members: + :undoc-members: + :show-inheritance: + +dpkt.smb module +--------------- + +.. automodule:: dpkt.smb + :members: + :undoc-members: + :show-inheritance: + +dpkt.snoop module +----------------- + +.. automodule:: dpkt.snoop + :members: + :undoc-members: + :show-inheritance: + +dpkt.ssl module +--------------- + +.. automodule:: dpkt.ssl + :members: + :undoc-members: + :show-inheritance: + +dpkt.ssl_ciphersuites module +---------------------------- + +.. automodule:: dpkt.ssl_ciphersuites + :members: + :undoc-members: + :show-inheritance: + +dpkt.stp module +--------------- + +.. automodule:: dpkt.stp + :members: + :undoc-members: + :show-inheritance: + +dpkt.stun module +---------------- + +.. automodule:: dpkt.stun + :members: + :undoc-members: + :show-inheritance: + +dpkt.tcp module +--------------- + +.. automodule:: dpkt.tcp + :members: + :undoc-members: + :show-inheritance: + +dpkt.telnet module +------------------ + +.. automodule:: dpkt.telnet + :members: + :undoc-members: + :show-inheritance: + +dpkt.tftp module +---------------- + +.. automodule:: dpkt.tftp + :members: + :undoc-members: + :show-inheritance: + +dpkt.tns module +--------------- + +.. automodule:: dpkt.tns + :members: + :undoc-members: + :show-inheritance: + +dpkt.tpkt module +---------------- + +.. automodule:: dpkt.tpkt + :members: + :undoc-members: + :show-inheritance: + +dpkt.udp module +--------------- + +.. automodule:: dpkt.udp + :members: + :undoc-members: + :show-inheritance: + +dpkt.vrrp module +---------------- + +.. automodule:: dpkt.vrrp + :members: + :undoc-members: + :show-inheritance: + +dpkt.yahoo module +----------------- + +.. automodule:: dpkt.yahoo + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/api/ethernet.rst b/docs/api/ethernet.rst deleted file mode 100644 index fb2c05f..0000000 --- a/docs/api/ethernet.rst +++ /dev/null @@ -1,9 +0,0 @@ -******** -Ethernet -******** - -.. module:: dpkt.ethernet - -.. autoclass:: Ethernet - :members: - diff --git a/docs/api/http.rst b/docs/api/http.rst deleted file mode 100644 index f03b842..0000000 --- a/docs/api/http.rst +++ /dev/null @@ -1,15 +0,0 @@ -**** -HTTP -**** - -.. module:: dpkt.http - -.. autoclass:: Message - :members: - -.. autoclass:: Request - :members: - -.. autoclass:: Response - :members: - diff --git a/docs/api/index.rst b/docs/api/index.rst index 0123c60..5975dd5 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -6,10 +6,6 @@ The dpkt API reference section is current a large work in progress, please have **Sections** .. toctree:: - :maxdepth: 1 + :maxdepth: 4 - ethernet - ip - udp - tcp - http + api_auto diff --git a/docs/api/ip.rst b/docs/api/ip.rst deleted file mode 100644 index f40a30b..0000000 --- a/docs/api/ip.rst +++ /dev/null @@ -1,9 +0,0 @@ -** -IP -** - -.. module:: dpkt.ip - -.. autoclass:: IP - :members: - diff --git a/docs/api/tcp.rst b/docs/api/tcp.rst deleted file mode 100644 index 500b33f..0000000 --- a/docs/api/tcp.rst +++ /dev/null @@ -1,9 +0,0 @@ -*** -TCP -*** - -.. module:: dpkt.tcp - -.. autoclass:: TCP - :members: - diff --git a/docs/api/udp.rst b/docs/api/udp.rst deleted file mode 100644 index 8f30364..0000000 --- a/docs/api/udp.rst +++ /dev/null @@ -1,9 +0,0 @@ -*** -UDP -*** - -.. module:: dpkt.udp - -.. autoclass:: UDP - :members: - diff --git a/docs/index.rst b/docs/index.rst index df98bad..cddb898 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,13 +13,6 @@ Getting Started quickstart examples -API Reference -============= -.. toctree:: - :maxdepth: 2 - - api/index - About dpkt ========== .. toctree:: @@ -31,3 +24,9 @@ About dpkt contributing license +API Reference +============= +.. toctree:: + :maxdepth: 2 + + api/index