summaryrefslogtreecommitdiff
path: root/doc/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst30
1 files changed, 19 insertions, 11 deletions
diff --git a/doc/index.rst b/doc/index.rst
index b680929..ec6bc69 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -21,37 +21,45 @@ Indices and tables
API Documentation
=================
+Front-end Modules
+-----------------
+These modules are the ones that you will need to use directly to implement a
+TFTP client or server.
+
TFTPy Module
-------------
+~~~~~~~~~~~~
.. automodule:: tftpy
:members:
tftpy.TftpClient
-----------------
+~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpClient
:members:
+tftpy.TftpServer
+~~~~~~~~~~~~~~~~
+.. automodule:: tftpy.TftpServer
+ :members:
+
+Back-end Modules
+----------------
+
tftpy.TftpPacketFactory
------------------------
+~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpPacketFactory
:members:
tftpy.TftpPacketTypes
----------------------
+~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpPacketTypes
:members:
-tftpy.TftpServer
-----------------
-.. automodule:: tftpy.TftpServer
- :members:
-
tftpy.TftpShared
-----------------
+~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpShared
:members:
tftpy.TftpStates
-----------------
+~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpStates
:members: