[tor-commits] [stem/master] Include directory module in API docs

[atagar at torproject.org]

commit a69ebcae61a0cfded2fd582f8c9dfe36730e8147
Author: Damian Johnson <atagar at torproject.org>
Date:   Sun May 26 12:12:07 2019 -0700

    Include directory module in API docs
    
    Adding the directory module to our api docs, and fixing a few table of contents
    issues...
    
      /home/atagar/Desktop/stem/docs/api/directory.rst: WARNING: document isn't included in any toctree
      /home/atagar/Desktop/stem/docs/contents.rst: WARNING: document isn't included in any toctree
      /home/atagar/Desktop/stem/docs/tutorials/examples/check_digests.rst: WARNING: document isn't included in any toctree
      /home/atagar/Desktop/stem/docs/tutorials/examples/download_descriptor.rst: WARNING: document isn't included in any toctree
    
    The last outstanding one (contents.rst) is for the table of contents itself,
    and adding it causes a circular reference warning...
    
      /home/atagar/Desktop/stem/docs/contents.rst: WARNING: circular toctree references detected, ignoring: contents <- contents
    
    Not quite sure what sphinx wants us to do about that one so leaving it alone.
---
 docs/api.rst      | 1 +
 docs/contents.rst | 3 +++
 2 files changed, 4 insertions(+)

diff --git a/docs/api.rst b/docs/api.rst
index 5ada9ec8..2e2f9fae 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -40,6 +40,7 @@ remotely like Tor does.
  * `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>`_.
 
+* `stem.directory <api/directory.html>`_ - Directory authority and fallback directory information.
 * `stem.descriptor.reader <api/descriptor/reader.html>`_ - Reads and parses descriptor files from disk.
 * `stem.descriptor.remote <api/descriptor/remote.html>`_ - Downloads descriptors from directory mirrors and authorities.
 * `stem.descriptor.export <api/descriptor/export.html>`_ - Exports descriptors to other formats.
diff --git a/docs/contents.rst b/docs/contents.rst
index 2a3d96b0..fb4d6b24 100644
--- a/docs/contents.rst
+++ b/docs/contents.rst
@@ -14,7 +14,9 @@ Contents
    tutorials/down_the_rabbit_hole
    tutorials/double_double_toil_and_trouble
 
+   tutorials/examples/check_digests
    tutorials/examples/compare_flags
+   tutorials/examples/download_descriptor
    tutorials/examples/exit_used
    tutorials/examples/list_circuits
    tutorials/examples/relay_connections
@@ -30,6 +32,7 @@ Contents
 
    api/control
    api/connection
+   api/directory
    api/socket
    api/process
    api/response