diff --git a/doc/conf.py b/doc/conf.py index 59c690d..670d2de 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -16,7 +16,6 @@ import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.append(os.path.abspath('.')) sys.path.append(os.path.abspath('..')) # -- General configuration ----------------------------------------------------- diff --git a/doc/index.rst b/doc/index.rst index ec6bc69..d9dec00 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,21 +3,29 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to TFTPy's documentation! -================================= +TFTPy +===== -Contents: +TFTPy is a pure python TFTP implementation. .. toctree:: :maxdepth: 2 -Indices and tables -================== - * :ref:`genindex` * :ref:`modindex` * :ref:`search` +Requirements +============ +Python 2.3+, I think. I haven't tested in Python 2.3 in a while but it should +still work. Let me know if it doesn't. + +Installation +============ + +Examples +======== + API Documentation ================= @@ -26,40 +34,47 @@ Front-end Modules These modules are the ones that you will need to use directly to implement a TFTP client or server. -TFTPy Module -~~~~~~~~~~~~ +The :mod:`tftpy` Module +~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy :members: + :show-inheritance: -tftpy.TftpClient -~~~~~~~~~~~~~~~~ +The `TftpClient` Module +~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpClient :members: + :show-inheritance: -tftpy.TftpServer -~~~~~~~~~~~~~~~~ +The `TftpServer` Module +~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpServer :members: + :show-inheritance: Back-end Modules ---------------- -tftpy.TftpPacketFactory -~~~~~~~~~~~~~~~~~~~~~~~ +The `TftpPacketFactory` Module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpPacketFactory :members: + :show-inheritance: -tftpy.TftpPacketTypes -~~~~~~~~~~~~~~~~~~~~~ +The `TftpPacketTypes` Module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpPacketTypes :members: + :show-inheritance: -tftpy.TftpShared -~~~~~~~~~~~~~~~~ +The `TftpShared` Module +~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpShared :members: + :show-inheritance: -tftpy.TftpStates -~~~~~~~~~~~~~~~~ +The `TftpStates` Module +~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpStates :members: + :show-inheritance: diff --git a/html/sphinx/_sources/index.txt b/html/sphinx/_sources/index.txt index ec6bc69..d9dec00 100644 --- a/html/sphinx/_sources/index.txt +++ b/html/sphinx/_sources/index.txt @@ -3,21 +3,29 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to TFTPy's documentation! -================================= +TFTPy +===== -Contents: +TFTPy is a pure python TFTP implementation. .. toctree:: :maxdepth: 2 -Indices and tables -================== - * :ref:`genindex` * :ref:`modindex` * :ref:`search` +Requirements +============ +Python 2.3+, I think. I haven't tested in Python 2.3 in a while but it should +still work. Let me know if it doesn't. + +Installation +============ + +Examples +======== + API Documentation ================= @@ -26,40 +34,47 @@ Front-end Modules These modules are the ones that you will need to use directly to implement a TFTP client or server. -TFTPy Module -~~~~~~~~~~~~ +The :mod:`tftpy` Module +~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy :members: + :show-inheritance: -tftpy.TftpClient -~~~~~~~~~~~~~~~~ +The `TftpClient` Module +~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpClient :members: + :show-inheritance: -tftpy.TftpServer -~~~~~~~~~~~~~~~~ +The `TftpServer` Module +~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpServer :members: + :show-inheritance: Back-end Modules ---------------- -tftpy.TftpPacketFactory -~~~~~~~~~~~~~~~~~~~~~~~ +The `TftpPacketFactory` Module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpPacketFactory :members: + :show-inheritance: -tftpy.TftpPacketTypes -~~~~~~~~~~~~~~~~~~~~~ +The `TftpPacketTypes` Module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpPacketTypes :members: + :show-inheritance: -tftpy.TftpShared -~~~~~~~~~~~~~~~~ +The `TftpShared` Module +~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpShared :members: + :show-inheritance: -tftpy.TftpStates -~~~~~~~~~~~~~~~~ +The `TftpStates` Module +~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: tftpy.TftpStates :members: + :show-inheritance: diff --git a/html/sphinx/_static/default.css b/html/sphinx/_static/default.css index 3725744..42ed6ec 100644 --- a/html/sphinx/_static/default.css +++ b/html/sphinx/_static/default.css @@ -166,18 +166,6 @@ div.admonition p.admonition-title + p { display: inline; } -div.admonition p { - margin-bottom: 5px; -} - -div.admonition pre { - margin-bottom: 5px; -} - -div.admonition ul, div.admonition ol { - margin-bottom: 5px; -} - div.note { background-color: #eee; border: 1px solid #ccc; diff --git a/html/sphinx/genindex.html b/html/sphinx/genindex.html index fdda253..67b8f85 100644 --- a/html/sphinx/genindex.html +++ b/html/sphinx/genindex.html @@ -255,7 +255,7 @@