This repository has been archived on 2023-10-10. You can view files and clone it, but cannot push or open issues/pull-requests.
khepri-tftpy/doc/index.rst

66 lines
1.2 KiB
ReStructuredText

.. TFTPy documentation master file, created by
sphinx-quickstart on Sun Jul 11 18:48:32 2010.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to TFTPy's documentation!
=================================
Contents:
.. toctree::
:maxdepth: 2
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
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.TftpShared
~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpShared
:members:
tftpy.TftpStates
~~~~~~~~~~~~~~~~
.. automodule:: tftpy.TftpStates
:members: