commit bf49f7dddfa7500b2bb91efacf840d0c393d86fe Author: Damian Johnson <atagar@torproject.org> Date: Sun Jan 20 17:43:03 2019 -0800 Generate BandwidthFile api docs --- docs/api.rst | 1 + docs/api/descriptor/bandwidth_file.rst | 5 +++++ docs/change_log.rst | 1 + docs/contents.rst | 1 + 4 files changed, 8 insertions(+) diff --git a/docs/api.rst b/docs/api.rst index 307184dc..5ada9ec8 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -36,6 +36,7 @@ remotely like Tor does. * `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. * `stem.descriptor.hidden_service_descriptor <api/descriptor/hidden_service_descriptor.html>`_ - Descriptors generated for hidden services. + * `stem.descriptor.bandwidth_file <api/descriptor/bandwidth_file.html>`_ - Bandwidth authority metrics. * `stem.descriptor.tordnsel <api/descriptor/tordnsel.html>`_ - `TorDNSEL <https://www.torproject.org/projects/tordnsel.html.en>`_ exit lists. * `stem.descriptor.certificate <api/descriptor/certificate.html>`_ - `Ed25519 certificates <https://gitweb.torproject.org/torspec.git/tree/cert-spec.txt>`_. diff --git a/docs/api/descriptor/bandwidth_file.rst b/docs/api/descriptor/bandwidth_file.rst new file mode 100644 index 00000000..dba56266 --- /dev/null +++ b/docs/api/descriptor/bandwidth_file.rst @@ -0,0 +1,5 @@ +Bandwidth File +============== + +.. automodule:: stem.descriptor.bandwidth_file + diff --git a/docs/change_log.rst b/docs/change_log.rst index bd954e42..c851f7fe 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -53,6 +53,7 @@ The following are only available within Stem's `git repository * **Descriptors** + * `Bandwidth file support <api/descriptor/bandwidth_file.html>`_ (:trac:`29056`) * Added :func:`stem.descriptor.remote.get_microdescriptors` * Added :class:`~stem.descriptor.networkstatus.DetachedSignature` parsing (:trac:`28495`) * Added :func:`~stem.descriptor.__init__.Descriptor.from_str` method (:trac:`28450`) diff --git a/docs/contents.rst b/docs/contents.rst index c9c38ebf..2a3d96b0 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -38,6 +38,7 @@ Contents api/manual api/version + api/descriptor/bandwidth_file api/descriptor/certificate api/descriptor/descriptor api/descriptor/server_descriptor