[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
[tor-commits] [stem/master] Collecting API stubs under a directory
commit 4167d59d8fa9d72656381dec39c6a7315176ebed
Author: Damian Johnson <atagar@xxxxxxxxxxxxxx>
Date: Sat Oct 27 16:57:34 2012 -0700
Collecting API stubs under a directory
Moving all the autodoc stubs under an api directory to keep things tidy.
---
docs/api.rst | 36 +++++++++++++-------------
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/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/contents.rst | 36 +++++++++++++-------------
docs/descriptor/descriptor.rst | 5 ---
docs/descriptor/export.rst | 5 ---
docs/descriptor/extrainfo_descriptor.rst | 5 ---
docs/descriptor/networkstatus.rst | 5 ---
docs/descriptor/reader.rst | 5 ---
docs/descriptor/router_status_entry.rst | 5 ---
docs/descriptor/server_descriptor.rst | 5 ---
docs/types/exit_policy.rst | 5 ---
docs/types/version.rst | 5 ---
docs/util/conf.rst | 5 ---
docs/util/connection.rst | 5 ---
docs/util/enum.rst | 5 ---
docs/util/log.rst | 5 ---
docs/util/proc.rst | 5 ---
docs/util/str_tools.rst | 5 ---
docs/util/system.rst | 5 ---
docs/util/term.rst | 5 ---
docs/util/tor_tools.rst | 5 ---
38 files changed, 126 insertions(+), 126 deletions(-)
diff --git a/docs/api.rst b/docs/api.rst
index 2351775..e35a29a 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -4,33 +4,33 @@ API
Types
-----
-* `stem.exit_policy <types/exit_policy.html>`_ - Relay policy for the destinations it will or won't allow traffic to.
-* `stem.version <types/version.html>`_ - Tor versions that can be compared to determine Tor's capablilites.
+* `stem.exit_policy <api/exit_policy.html>`_ - Relay policy for the destinations it will or won't allow traffic to.
+* `stem.version <api/version.html>`_ - Tor versions that can be compared to determine Tor's capablilites.
Descriptors
-----------
* **Classes**
- * `stem.descriptor <descriptor/descriptor.html>`_ - Base class for descriptors.
- * `stem.descriptor.server_descriptor <descriptor/server_descriptor.html>`_ - Relay and bridge server descriptors.
- * `stem.descriptor.extrainfo_descriptor <descriptor/extrainfo_descriptor.html>`_ - Relay and bridge extrainfo descriptors.
- * `stem.descriptor.networkstatus <descriptor/networkstatus.html>`_ - Network status documents which make up the Tor consensus.
- * `stem.descriptor.router_status_entry <descriptor/router_status_entry.html>`_ - Relay entries within a network status document.
+ * `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.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.reader <descriptor/reader.html>`_ - Reads and parses descriptor files from disk.
-* `stem.descriptor.export <descriptor/export.html>`_ - Exports descriptors to other formats.
+* `stem.descriptor.reader <api/descriptor/reader.html>`_ - Reads and parses descriptor files from disk.
+* `stem.descriptor.export <api/descriptor/export.html>`_ - Exports descriptors to other formats.
Utilities
---------
-* `stem.util.conf <util/conf.html>`_ - Configuration file handling.
-* `stem.util.connection <util/connection.html>`_ - Connection and IP related utilities.
-* `stem.util.enum <util/enum.html>`_ - Enumeration class.
-* `stem.util.log <util/log.html>`_ - Logging utilities.
-* `stem.util.proc <util/proc.html>`_ - Tools to read a process' proc contents.
-* `stem.util.str_tools <util/str_tools.html>`_ - String utilities.
-* `stem.util.system <util/system.html>`_ - Tools related to the local system.
-* `stem.util.term <util/term.html>`_ - Tools for interacting with the terminal.
-* `stem.util.tor_tools <util/tor_tools.html>`_ - Helper functions for working with tor.
+* `stem.util.conf <api/util/conf.html>`_ - Configuration file handling.
+* `stem.util.connection <api/util/connection.html>`_ - Connection and IP related utilities.
+* `stem.util.enum <api/util/enum.html>`_ - Enumeration class.
+* `stem.util.log <api/util/log.html>`_ - Logging utilities.
+* `stem.util.proc <api/util/proc.html>`_ - Tools to read a process' proc contents.
+* `stem.util.str_tools <api/util/str_tools.html>`_ - String utilities.
+* `stem.util.system <api/util/system.html>`_ - Tools related to the local system.
+* `stem.util.term <api/util/term.html>`_ - Tools for interacting with the terminal.
+* `stem.util.tor_tools <api/util/tor_tools.html>`_ - Helper functions for working with tor.
diff --git a/docs/api/descriptor/descriptor.rst b/docs/api/descriptor/descriptor.rst
new file mode 100644
index 0000000..0273b53
--- /dev/null
+++ b/docs/api/descriptor/descriptor.rst
@@ -0,0 +1,5 @@
+Descriptor
+==========
+
+.. automodule:: stem.descriptor.__init__
+
diff --git a/docs/api/descriptor/export.rst b/docs/api/descriptor/export.rst
new file mode 100644
index 0000000..a39e777
--- /dev/null
+++ b/docs/api/descriptor/export.rst
@@ -0,0 +1,5 @@
+Descriptor Exporter
+===================
+
+.. automodule:: stem.descriptor.export
+
diff --git a/docs/api/descriptor/extrainfo_descriptor.rst b/docs/api/descriptor/extrainfo_descriptor.rst
new file mode 100644
index 0000000..1356dae
--- /dev/null
+++ b/docs/api/descriptor/extrainfo_descriptor.rst
@@ -0,0 +1,5 @@
+Extrainfo Descriptor
+====================
+
+.. automodule:: stem.descriptor.extrainfo_descriptor
+
diff --git a/docs/api/descriptor/networkstatus.rst b/docs/api/descriptor/networkstatus.rst
new file mode 100644
index 0000000..44b8bb3
--- /dev/null
+++ b/docs/api/descriptor/networkstatus.rst
@@ -0,0 +1,5 @@
+Network Status Documents
+========================
+
+.. automodule:: stem.descriptor.networkstatus
+
diff --git a/docs/api/descriptor/reader.rst b/docs/api/descriptor/reader.rst
new file mode 100644
index 0000000..89c1a69
--- /dev/null
+++ b/docs/api/descriptor/reader.rst
@@ -0,0 +1,5 @@
+Descriptor Reader
+=================
+
+.. automodule:: stem.descriptor.reader
+
diff --git a/docs/api/descriptor/router_status_entry.rst b/docs/api/descriptor/router_status_entry.rst
new file mode 100644
index 0000000..90b2b01
--- /dev/null
+++ b/docs/api/descriptor/router_status_entry.rst
@@ -0,0 +1,5 @@
+Router Status Entries
+=====================
+
+.. automodule:: stem.descriptor.router_status_entry
+
diff --git a/docs/api/descriptor/server_descriptor.rst b/docs/api/descriptor/server_descriptor.rst
new file mode 100644
index 0000000..c46f391
--- /dev/null
+++ b/docs/api/descriptor/server_descriptor.rst
@@ -0,0 +1,5 @@
+Server Descriptor
+=================
+
+.. automodule:: stem.descriptor.server_descriptor
+
diff --git a/docs/api/exit_policy.rst b/docs/api/exit_policy.rst
new file mode 100644
index 0000000..2963fa8
--- /dev/null
+++ b/docs/api/exit_policy.rst
@@ -0,0 +1,5 @@
+Exit Policy
+===========
+
+.. automodule:: stem.exit_policy
+
diff --git a/docs/api/util/conf.rst b/docs/api/util/conf.rst
new file mode 100644
index 0000000..15ce123
--- /dev/null
+++ b/docs/api/util/conf.rst
@@ -0,0 +1,5 @@
+Configuration File Handling
+===========================
+
+.. automodule:: stem.util.conf
+
diff --git a/docs/api/util/connection.rst b/docs/api/util/connection.rst
new file mode 100644
index 0000000..63e3b96
--- /dev/null
+++ b/docs/api/util/connection.rst
@@ -0,0 +1,5 @@
+Connection Utilities
+====================
+
+.. automodule:: stem.util.connection
+
diff --git a/docs/api/util/enum.rst b/docs/api/util/enum.rst
new file mode 100644
index 0000000..b00dca4
--- /dev/null
+++ b/docs/api/util/enum.rst
@@ -0,0 +1,5 @@
+Enumerations
+============
+
+.. automodule:: stem.util.enum
+
diff --git a/docs/api/util/log.rst b/docs/api/util/log.rst
new file mode 100644
index 0000000..1b7e2b1
--- /dev/null
+++ b/docs/api/util/log.rst
@@ -0,0 +1,5 @@
+Logging
+=======
+
+.. automodule:: stem.util.log
+
diff --git a/docs/api/util/proc.rst b/docs/api/util/proc.rst
new file mode 100644
index 0000000..c5224a8
--- /dev/null
+++ b/docs/api/util/proc.rst
@@ -0,0 +1,5 @@
+Proc Utilities
+==============
+
+.. automodule:: stem.util.proc
+
diff --git a/docs/api/util/str_tools.rst b/docs/api/util/str_tools.rst
new file mode 100644
index 0000000..4e15def
--- /dev/null
+++ b/docs/api/util/str_tools.rst
@@ -0,0 +1,5 @@
+String Utilities
+================
+
+.. automodule:: stem.util.str_tools
+
diff --git a/docs/api/util/system.rst b/docs/api/util/system.rst
new file mode 100644
index 0000000..95cabb5
--- /dev/null
+++ b/docs/api/util/system.rst
@@ -0,0 +1,5 @@
+System Utilities
+================
+
+.. automodule:: stem.util.system
+
diff --git a/docs/api/util/term.rst b/docs/api/util/term.rst
new file mode 100644
index 0000000..d9223f4
--- /dev/null
+++ b/docs/api/util/term.rst
@@ -0,0 +1,5 @@
+Terminal Utilities
+==================
+
+.. automodule:: stem.util.term
+
diff --git a/docs/api/util/tor_tools.rst b/docs/api/util/tor_tools.rst
new file mode 100644
index 0000000..87eb2af
--- /dev/null
+++ b/docs/api/util/tor_tools.rst
@@ -0,0 +1,5 @@
+Tor Utilities
+=============
+
+.. automodule:: stem.util.tor_tools
+
diff --git a/docs/api/version.rst b/docs/api/version.rst
new file mode 100644
index 0000000..ad9e875
--- /dev/null
+++ b/docs/api/version.rst
@@ -0,0 +1,5 @@
+Version
+=======
+
+.. automodule:: stem.version
+
diff --git a/docs/contents.rst b/docs/contents.rst
index 58230b3..1be4021 100644
--- a/docs/contents.rst
+++ b/docs/contents.rst
@@ -8,25 +8,25 @@ Contents
download
tutorial
- descriptor/export
- descriptor/reader
+ api/exit_policy
+ api/version
- descriptor/descriptor
- descriptor/server_descriptor
- descriptor/extrainfo_descriptor
- descriptor/networkstatus
- descriptor/router_status_entry
+ api/descriptor/export
+ api/descriptor/reader
- types/exit_policy
- types/version
+ api/descriptor/descriptor
+ api/descriptor/server_descriptor
+ api/descriptor/extrainfo_descriptor
+ api/descriptor/networkstatus
+ api/descriptor/router_status_entry
- util/conf
- util/connection
- util/enum
- util/log
- util/proc
- util/str_tools
- util/system
- util/term
- util/tor_tools
+ api/util/conf
+ api/util/connection
+ api/util/enum
+ api/util/log
+ api/util/proc
+ api/util/str_tools
+ api/util/system
+ api/util/term
+ api/util/tor_tools
diff --git a/docs/descriptor/descriptor.rst b/docs/descriptor/descriptor.rst
deleted file mode 100644
index 0273b53..0000000
--- a/docs/descriptor/descriptor.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Descriptor
-==========
-
-.. automodule:: stem.descriptor.__init__
-
diff --git a/docs/descriptor/export.rst b/docs/descriptor/export.rst
deleted file mode 100644
index a39e777..0000000
--- a/docs/descriptor/export.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Descriptor Exporter
-===================
-
-.. automodule:: stem.descriptor.export
-
diff --git a/docs/descriptor/extrainfo_descriptor.rst b/docs/descriptor/extrainfo_descriptor.rst
deleted file mode 100644
index 1356dae..0000000
--- a/docs/descriptor/extrainfo_descriptor.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Extrainfo Descriptor
-====================
-
-.. automodule:: stem.descriptor.extrainfo_descriptor
-
diff --git a/docs/descriptor/networkstatus.rst b/docs/descriptor/networkstatus.rst
deleted file mode 100644
index 44b8bb3..0000000
--- a/docs/descriptor/networkstatus.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Network Status Documents
-========================
-
-.. automodule:: stem.descriptor.networkstatus
-
diff --git a/docs/descriptor/reader.rst b/docs/descriptor/reader.rst
deleted file mode 100644
index 89c1a69..0000000
--- a/docs/descriptor/reader.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Descriptor Reader
-=================
-
-.. automodule:: stem.descriptor.reader
-
diff --git a/docs/descriptor/router_status_entry.rst b/docs/descriptor/router_status_entry.rst
deleted file mode 100644
index 90b2b01..0000000
--- a/docs/descriptor/router_status_entry.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Router Status Entries
-=====================
-
-.. automodule:: stem.descriptor.router_status_entry
-
diff --git a/docs/descriptor/server_descriptor.rst b/docs/descriptor/server_descriptor.rst
deleted file mode 100644
index c46f391..0000000
--- a/docs/descriptor/server_descriptor.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Server Descriptor
-=================
-
-.. automodule:: stem.descriptor.server_descriptor
-
diff --git a/docs/types/exit_policy.rst b/docs/types/exit_policy.rst
deleted file mode 100644
index 2963fa8..0000000
--- a/docs/types/exit_policy.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Exit Policy
-===========
-
-.. automodule:: stem.exit_policy
-
diff --git a/docs/types/version.rst b/docs/types/version.rst
deleted file mode 100644
index ad9e875..0000000
--- a/docs/types/version.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Version
-=======
-
-.. automodule:: stem.version
-
diff --git a/docs/util/conf.rst b/docs/util/conf.rst
deleted file mode 100644
index 15ce123..0000000
--- a/docs/util/conf.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Configuration File Handling
-===========================
-
-.. automodule:: stem.util.conf
-
diff --git a/docs/util/connection.rst b/docs/util/connection.rst
deleted file mode 100644
index 63e3b96..0000000
--- a/docs/util/connection.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Connection Utilities
-====================
-
-.. automodule:: stem.util.connection
-
diff --git a/docs/util/enum.rst b/docs/util/enum.rst
deleted file mode 100644
index b00dca4..0000000
--- a/docs/util/enum.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Enumerations
-============
-
-.. automodule:: stem.util.enum
-
diff --git a/docs/util/log.rst b/docs/util/log.rst
deleted file mode 100644
index 1b7e2b1..0000000
--- a/docs/util/log.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Logging
-=======
-
-.. automodule:: stem.util.log
-
diff --git a/docs/util/proc.rst b/docs/util/proc.rst
deleted file mode 100644
index c5224a8..0000000
--- a/docs/util/proc.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Proc Utilities
-==============
-
-.. automodule:: stem.util.proc
-
diff --git a/docs/util/str_tools.rst b/docs/util/str_tools.rst
deleted file mode 100644
index 4e15def..0000000
--- a/docs/util/str_tools.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-String Utilities
-================
-
-.. automodule:: stem.util.str_tools
-
diff --git a/docs/util/system.rst b/docs/util/system.rst
deleted file mode 100644
index 95cabb5..0000000
--- a/docs/util/system.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-System Utilities
-================
-
-.. automodule:: stem.util.system
-
diff --git a/docs/util/term.rst b/docs/util/term.rst
deleted file mode 100644
index d9223f4..0000000
--- a/docs/util/term.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Terminal Utilities
-==================
-
-.. automodule:: stem.util.term
-
diff --git a/docs/util/tor_tools.rst b/docs/util/tor_tools.rst
deleted file mode 100644
index 87eb2af..0000000
--- a/docs/util/tor_tools.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-Tor Utilities
-=============
-
-.. automodule:: stem.util.tor_tools
-
_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits