commit 39d90df0f9f48c318a9e1ba4ca32836b40a6eb81 Merge: a00fb8a f31b19b Author: Damian Johnson atagar@torproject.org Date: Sun Oct 28 13:54:05 2012 -0700

Revised API documentation

Stem's API docs were a monolithic dump of our pydocs. This was utterly unreadable so breaking it down into individual module pages. I also applied some uniform formatting changes to all of our pydocs to make them more reader friendly.

docs/Makefile | 2 - docs/api.rst | 64 +++--- docs/api/connection.rst | 5 + docs/api/control.rst | 5 + docs/api/descriptor/descriptor.rst | 5 + docs/api/descriptor/export.rst | 5 + docs/api/descriptor/extrainfo_descriptor.rst | 5 + docs/api/descriptor/networkstatus.rst | 5 + docs/api/descriptor/reader.rst | 5 + docs/api/descriptor/router_status_entry.rst | 5 + docs/api/descriptor/server_descriptor.rst | 5 + docs/api/exit_policy.rst | 5 + docs/api/process.rst | 5 + docs/api/response.rst | 14 ++ docs/api/socket.rst | 5 + docs/api/util/conf.rst | 5 + docs/api/util/connection.rst | 5 + docs/api/util/enum.rst | 5 + docs/api/util/log.rst | 5 + docs/api/util/proc.rst | 5 + docs/api/util/str_tools.rst | 5 + docs/api/util/system.rst | 5 + docs/api/util/term.rst | 5 + docs/api/util/tor_tools.rst | 5 + docs/api/version.rst | 5 + docs/conf.py | 9 - docs/contents.rst | 38 ++++ docs/download.rst | 4 +- docs/index.rst | 7 +- stem/connection.py | 290 ++++++++++++++++---------- stem/control.py | 286 +++++++++++++++----------- stem/descriptor/__init__.py | 34 ++-- stem/descriptor/export.py | 31 ++- stem/descriptor/extrainfo_descriptor.py | 64 ++++--- stem/descriptor/networkstatus.py | 122 +++++++----- stem/descriptor/reader.py | 122 +++++++---- stem/descriptor/router_status_entry.py | 69 ++++--- stem/descriptor/server_descriptor.py | 72 ++++--- stem/exit_policy.py | 108 ++++++----- stem/prereq.py | 4 +- stem/process.py | 34 ++-- stem/response/__init__.py | 101 +++++---- stem/response/getconf.py | 3 +- stem/response/getinfo.py | 2 +- stem/response/protocolinfo.py | 30 +--- stem/socket.py | 84 ++++---- stem/util/conf.py | 224 ++++++++++++++------ stem/util/connection.py | 30 ++-- stem/util/enum.py | 40 ++-- stem/util/log.py | 20 +- stem/util/proc.py | 37 ++-- stem/util/str_tools.py | 21 +- stem/util/system.py | 44 +++-- stem/util/term.py | 27 +++- stem/util/tor_tools.py | 14 +- stem/version.py | 52 +++--- test/check_whitespace.py | 2 +- test/mocking.py | 14 +- test/output.py | 4 +- test/prompt.py | 2 +- test/runner.py | 12 +- 61 files changed, 1364 insertions(+), 883 deletions(-)