commit fce9b2e92f4d6bf9a01431f993fd0e42dcd6f6ad Author: Damian Johnson atagar@torproject.org Date: Sun Mar 3 16:12:24 2013 -0800

Adding microdescriptors to our api docs --- docs/api.rst | 1 + docs/api/descriptor/microdescriptor.rst | 5 +++++ docs/contents.rst | 1 + 3 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/docs/api.rst b/docs/api.rst index 3f9d770..6ea028a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -29,6 +29,7 @@ individual files and `stem.descriptor.reader * `stem.descriptor <api/descriptor/descriptor.html>`_ - Base class for descriptors. * `stem.descriptor.server_descriptor <api/descriptor/server_descriptor.html>`_ - Relay and bridge server descriptors. * `stem.descriptor.extrainfo_descriptor <api/descriptor/extrainfo_descriptor.html>`_ - Relay and bridge extrainfo descriptors. + * `stem.descriptor.microdescriptor <api/descriptor/microdescriptor.html>`_ - Minimalistic counterpart for server descriptors. * `stem.descriptor.networkstatus <api/descriptor/networkstatus.html>`_ - Network status documents which make up the Tor consensus. * `stem.descriptor.router_status_entry <api/descriptor/router_status_entry.html>`_ - Relay entries within a network status document.

diff --git a/docs/api/descriptor/microdescriptor.rst b/docs/api/descriptor/microdescriptor.rst new file mode 100644 index 0000000..b559ea5 --- /dev/null +++ b/docs/api/descriptor/microdescriptor.rst @@ -0,0 +1,5 @@ +MicroDescriptor +=============== + +.. automodule:: stem.descriptor.microdescriptor + diff --git a/docs/contents.rst b/docs/contents.rst index 4757212..fbf2495 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -24,6 +24,7 @@ Contents api/descriptor/descriptor api/descriptor/server_descriptor api/descriptor/extrainfo_descriptor + api/descriptor/microdescriptor api/descriptor/networkstatus api/descriptor/router_status_entry