diff --git a/apps/sam/python/doc/epydoc/calldoc.py b/apps/sam/python/doc/epydoc/calldoc.py new file mode 100644 index 000000000..0cc8d730f --- /dev/null +++ b/apps/sam/python/doc/epydoc/calldoc.py @@ -0,0 +1,18 @@ +#!/usr/local/bin/python + +# +# Call the command line interface for Epydoc. +# + +# We have to do some path magic to prevent Python from getting +# confused about the difference between this epydoc module, and the +# real epydoc package. So sys.path[0], which contains the directory +# of the script. +import sys, os.path +script_path = os.path.abspath(sys.path[0]) +sys.path = [p for p in sys.path if + os.path.abspath(p) != script_path] + +from epydoc.cli import cli +cli() + diff --git a/apps/sam/python/doc/epydoc/makedoc.py b/apps/sam/python/doc/epydoc/makedoc.py new file mode 100644 index 000000000..7af6fc464 --- /dev/null +++ b/apps/sam/python/doc/epydoc/makedoc.py @@ -0,0 +1,35 @@ +#! /usr/bin/env python + +""" +Make epydoc HTML documentation in the 'html' subdirectory. +""" + +import epydoc as epydoc_ +import inspect +import os, sys + +def epydoc(args): + """Run epydoc (command line) with given argument string.""" + os.system('python calldoc.py ' + args) + +def makedoc(): + """Make all epydoc HTML documentation for Python I2P library.""" + modlist = [ + 'i2p', + 'i2p.eep', + 'i2p.tunnel', + 'i2p.router', + 'i2p.socket', + 'i2p.select', + 'i2p.samclasses', + 'i2p.CGIHTTPServer', + 'i2p.SimpleHTTPServer', + 'i2p.BaseHTTPServer', + 'i2p.SocketServer', + 'i2p.pylib' + ] + modlist.reverse() + epydoc('--html ' + ' '.join(modlist)) + +if __name__ == '__main__': + makedoc() diff --git a/apps/sam/python/doc/pydoc/i2p.eep.html b/apps/sam/python/doc/pydoc/i2p.eep.html deleted file mode 100644 index 553ef3d9e..000000000 --- a/apps/sam/python/doc/pydoc/i2p.eep.html +++ /dev/null @@ -1,40 +0,0 @@ - - -
- i2p.eep | index d:\code\i2p\i2p\eep.py |
Eeproxy Python API
--
-Modules | ||||||
- |
|
-
-Functions | ||
- |
|
-
-Data | ||
- | eepaddr = '127.0.0.1:4444' |
- i2p | index d:\code\i2p\i2p\__init__.py |
i2p -- I2P Python interface
--
-Package Contents | ||||||
- |
|
-
-Classes | ||||||||||||||||||
- |
-
-
|
-
-Data | ||
- | __all__ = ['Error', 'RouterError', 'sam', 'eep', 'router'] |
- i2p.router | index d:\code\i2p\i2p\router.py |
Router Control API for Python
--
-Modules | ||||||
- |
|
-
-Data | ||
- | check_addrlist = ['127.0.0.1:7656', '127.0.0.1:4444'] -our_router = False -our_router_lock = <thread.lock object at 0x008AD0F0> -router_config = 'router.config' |
- i2p.sam | index d:\code\i2p\i2p\sam.py |
SAM Python API
--
-Modules | ||||||
- |
|
-
-Classes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
- -
-
-
-
-
-
-
-
-
-
|
-
-Data | ||
- | MAX_DGRAM = 31744 -MAX_RAW = 32768 -MSG_DONTWAIT = 128 -MSG_PEEK = 2 -MSG_WAITALL = 64 -POLLERR = 8 -POLLHUP = 16 -POLLIN = 1 -POLLNVAL = 32 -POLLOUT = 4 -POLLPRI = 1 -SOCK_DGRAM = 2 -SOCK_RAW = 3 -SOCK_STREAM = 1 -samaddr = '127.0.0.1:7656' -samver = 1.0 |
- i2p.samclasses | index d:\code\i2p\i2p\samclasses.py |
Lower-level SAM API, interfaces with SAM Bridge.
-
-For internal use only.
-
-Use the higher level i2p.sam module for your own programs.
-
-For details on SAM, see "Simple Anonymous Messaging (SAM) v1.0,"
-as published by jrandom.
-
-Class Overview:
-
- SAMTerminal: Message sender/reader, talks to SAM Bridge
- through a single socket.
- StringBuffer: Queue for character data.
- BaseSession: SAM session classes are derived from this.
- StreamSession: Manipulate a SAM stream session through a
- threadsafe, high-level interface.
- DatagramSession: SAM datagram session, threadsafe, high level.
- RawSession: SAM raw session, threadsafe, high level.
-
-Note that a 'None' timeout is an infinite timeout: it
-blocks forever if necessary.
-
-Todo:
- * Error handling is a huge mess. Neaten it up.
- Subclass a ErrorMixin class, then use set_error(e),
- check_error(), get_error().
- * Streams are a huge mess. Neaten them up.
- * This whole interface is a tad confusing. Neaten it up.
-
-Modules | ||||||
- |
|
-
-Classes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- |
-
-
-
-
-
-
-
-
|
-
-Data | ||
- | sam_log = False |