summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--sites/docs/api.rst8
-rw-r--r--sites/docs/api/agent.rst7
-rw-r--r--sites/docs/api/auth_handler.rst7
-rw-r--r--sites/docs/api/ber.rst7
-rw-r--r--sites/docs/api/buffered_pipe.rst7
-rw-r--r--sites/docs/api/channel.rst7
-rw-r--r--sites/docs/api/client.rst7
-rw-r--r--sites/docs/api/common.rst7
-rw-r--r--sites/docs/api/compress.rst7
-rw-r--r--sites/docs/api/config.rst7
-rw-r--r--sites/docs/api/dsskey.rst7
-rw-r--r--sites/docs/api/file.rst7
-rw-r--r--sites/docs/api/hostkeys.rst7
-rw-r--r--sites/docs/api/kex_gex.rst7
-rw-r--r--sites/docs/api/kex_group1.rst7
-rw-r--r--sites/docs/api/logging22.rst7
-rw-r--r--sites/docs/api/message.rst7
-rw-r--r--sites/docs/api/packet.rst7
-rw-r--r--sites/docs/api/pipe.rst7
-rw-r--r--sites/docs/api/pkey.rst7
-rw-r--r--sites/docs/api/primes.rst7
-rw-r--r--sites/docs/api/proxy.rst7
-rw-r--r--sites/docs/api/resource.rst7
-rw-r--r--sites/docs/api/rsakey.rst7
-rw-r--r--sites/docs/api/server.rst7
-rw-r--r--sites/docs/api/sftp.rst7
-rw-r--r--sites/docs/api/sftp_attr.rst7
-rw-r--r--sites/docs/api/sftp_client.rst7
-rw-r--r--sites/docs/api/sftp_file.rst7
-rw-r--r--sites/docs/api/sftp_handle.rst7
-rw-r--r--sites/docs/api/sftp_server.rst7
-rw-r--r--sites/docs/api/sftp_si.rst7
-rw-r--r--sites/docs/api/ssh_exception.rst7
-rw-r--r--sites/docs/api/transport.rst7
-rw-r--r--sites/docs/api/util.rst7
-rw-r--r--sites/docs/api/win_pageant.rst7
-rw-r--r--sites/docs/index.rst4
37 files changed, 248 insertions, 9 deletions
diff --git a/sites/docs/api.rst b/sites/docs/api.rst
deleted file mode 100644
index 47615709..00000000
--- a/sites/docs/api.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-.. _api:
-
-API
-===
-
-.. automodule:: paramiko
- :members:
- :special-members:
diff --git a/sites/docs/api/agent.rst b/sites/docs/api/agent.rst
new file mode 100644
index 00000000..cb966f2b
--- /dev/null
+++ b/sites/docs/api/agent.rst
@@ -0,0 +1,7 @@
+paramiko.agent module
+=====================
+
+.. automodule:: paramiko.agent
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/auth_handler.rst b/sites/docs/api/auth_handler.rst
new file mode 100644
index 00000000..c35f5b66
--- /dev/null
+++ b/sites/docs/api/auth_handler.rst
@@ -0,0 +1,7 @@
+paramiko.auth_handler module
+============================
+
+.. automodule:: paramiko.auth_handler
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/ber.rst b/sites/docs/api/ber.rst
new file mode 100644
index 00000000..3627528f
--- /dev/null
+++ b/sites/docs/api/ber.rst
@@ -0,0 +1,7 @@
+paramiko.ber module
+===================
+
+.. automodule:: paramiko.ber
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/buffered_pipe.rst b/sites/docs/api/buffered_pipe.rst
new file mode 100644
index 00000000..57411fc7
--- /dev/null
+++ b/sites/docs/api/buffered_pipe.rst
@@ -0,0 +1,7 @@
+paramiko.buffered_pipe module
+=============================
+
+.. automodule:: paramiko.buffered_pipe
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/channel.rst b/sites/docs/api/channel.rst
new file mode 100644
index 00000000..85848484
--- /dev/null
+++ b/sites/docs/api/channel.rst
@@ -0,0 +1,7 @@
+paramiko.channel module
+=======================
+
+.. automodule:: paramiko.channel
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/client.rst b/sites/docs/api/client.rst
new file mode 100644
index 00000000..50171371
--- /dev/null
+++ b/sites/docs/api/client.rst
@@ -0,0 +1,7 @@
+paramiko.client module
+======================
+
+.. automodule:: paramiko.client
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/common.rst b/sites/docs/api/common.rst
new file mode 100644
index 00000000..0abcf986
--- /dev/null
+++ b/sites/docs/api/common.rst
@@ -0,0 +1,7 @@
+paramiko.common module
+======================
+
+.. automodule:: paramiko.common
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/compress.rst b/sites/docs/api/compress.rst
new file mode 100644
index 00000000..9089efbd
--- /dev/null
+++ b/sites/docs/api/compress.rst
@@ -0,0 +1,7 @@
+paramiko.compress module
+========================
+
+.. automodule:: paramiko.compress
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/config.rst b/sites/docs/api/config.rst
new file mode 100644
index 00000000..fb587953
--- /dev/null
+++ b/sites/docs/api/config.rst
@@ -0,0 +1,7 @@
+paramiko.config module
+======================
+
+.. automodule:: paramiko.config
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/dsskey.rst b/sites/docs/api/dsskey.rst
new file mode 100644
index 00000000..67fbd84e
--- /dev/null
+++ b/sites/docs/api/dsskey.rst
@@ -0,0 +1,7 @@
+paramiko.dsskey module
+======================
+
+.. automodule:: paramiko.dsskey
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/file.rst b/sites/docs/api/file.rst
new file mode 100644
index 00000000..044ceab0
--- /dev/null
+++ b/sites/docs/api/file.rst
@@ -0,0 +1,7 @@
+paramiko.file module
+====================
+
+.. automodule:: paramiko.file
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/hostkeys.rst b/sites/docs/api/hostkeys.rst
new file mode 100644
index 00000000..0428fa92
--- /dev/null
+++ b/sites/docs/api/hostkeys.rst
@@ -0,0 +1,7 @@
+paramiko.hostkeys module
+========================
+
+.. automodule:: paramiko.hostkeys
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/kex_gex.rst b/sites/docs/api/kex_gex.rst
new file mode 100644
index 00000000..749853b3
--- /dev/null
+++ b/sites/docs/api/kex_gex.rst
@@ -0,0 +1,7 @@
+paramiko.kex_gex module
+=======================
+
+.. automodule:: paramiko.kex_gex
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/kex_group1.rst b/sites/docs/api/kex_group1.rst
new file mode 100644
index 00000000..8bef58d0
--- /dev/null
+++ b/sites/docs/api/kex_group1.rst
@@ -0,0 +1,7 @@
+paramiko.kex_group1 module
+==========================
+
+.. automodule:: paramiko.kex_group1
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/logging22.rst b/sites/docs/api/logging22.rst
new file mode 100644
index 00000000..55c17882
--- /dev/null
+++ b/sites/docs/api/logging22.rst
@@ -0,0 +1,7 @@
+paramiko.logging22 module
+=========================
+
+.. automodule:: paramiko.logging22
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/message.rst b/sites/docs/api/message.rst
new file mode 100644
index 00000000..4f7b5838
--- /dev/null
+++ b/sites/docs/api/message.rst
@@ -0,0 +1,7 @@
+paramiko.message module
+=======================
+
+.. automodule:: paramiko.message
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/packet.rst b/sites/docs/api/packet.rst
new file mode 100644
index 00000000..6a127d7a
--- /dev/null
+++ b/sites/docs/api/packet.rst
@@ -0,0 +1,7 @@
+paramiko.packet module
+======================
+
+.. automodule:: paramiko.packet
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/pipe.rst b/sites/docs/api/pipe.rst
new file mode 100644
index 00000000..5ec75fa5
--- /dev/null
+++ b/sites/docs/api/pipe.rst
@@ -0,0 +1,7 @@
+paramiko.pipe module
+====================
+
+.. automodule:: paramiko.pipe
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/pkey.rst b/sites/docs/api/pkey.rst
new file mode 100644
index 00000000..fb75e664
--- /dev/null
+++ b/sites/docs/api/pkey.rst
@@ -0,0 +1,7 @@
+paramiko.pkey module
+====================
+
+.. automodule:: paramiko.pkey
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/primes.rst b/sites/docs/api/primes.rst
new file mode 100644
index 00000000..8dfe2a47
--- /dev/null
+++ b/sites/docs/api/primes.rst
@@ -0,0 +1,7 @@
+paramiko.primes module
+======================
+
+.. automodule:: paramiko.primes
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/proxy.rst b/sites/docs/api/proxy.rst
new file mode 100644
index 00000000..5a0f5aff
--- /dev/null
+++ b/sites/docs/api/proxy.rst
@@ -0,0 +1,7 @@
+paramiko.proxy module
+=====================
+
+.. automodule:: paramiko.proxy
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/resource.rst b/sites/docs/api/resource.rst
new file mode 100644
index 00000000..a4527ab1
--- /dev/null
+++ b/sites/docs/api/resource.rst
@@ -0,0 +1,7 @@
+paramiko.resource module
+========================
+
+.. automodule:: paramiko.resource
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/rsakey.rst b/sites/docs/api/rsakey.rst
new file mode 100644
index 00000000..7ad995ce
--- /dev/null
+++ b/sites/docs/api/rsakey.rst
@@ -0,0 +1,7 @@
+paramiko.rsakey module
+======================
+
+.. automodule:: paramiko.rsakey
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/server.rst b/sites/docs/api/server.rst
new file mode 100644
index 00000000..3821c9be
--- /dev/null
+++ b/sites/docs/api/server.rst
@@ -0,0 +1,7 @@
+paramiko.server module
+======================
+
+.. automodule:: paramiko.server
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/sftp.rst b/sites/docs/api/sftp.rst
new file mode 100644
index 00000000..1d65900a
--- /dev/null
+++ b/sites/docs/api/sftp.rst
@@ -0,0 +1,7 @@
+paramiko.sftp module
+====================
+
+.. automodule:: paramiko.sftp
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/sftp_attr.rst b/sites/docs/api/sftp_attr.rst
new file mode 100644
index 00000000..114748c6
--- /dev/null
+++ b/sites/docs/api/sftp_attr.rst
@@ -0,0 +1,7 @@
+paramiko.sftp_attr module
+=========================
+
+.. automodule:: paramiko.sftp_attr
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/sftp_client.rst b/sites/docs/api/sftp_client.rst
new file mode 100644
index 00000000..ee973df2
--- /dev/null
+++ b/sites/docs/api/sftp_client.rst
@@ -0,0 +1,7 @@
+paramiko.sftp_client module
+===========================
+
+.. automodule:: paramiko.sftp_client
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/sftp_file.rst b/sites/docs/api/sftp_file.rst
new file mode 100644
index 00000000..77756807
--- /dev/null
+++ b/sites/docs/api/sftp_file.rst
@@ -0,0 +1,7 @@
+paramiko.sftp_file module
+=========================
+
+.. automodule:: paramiko.sftp_file
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/sftp_handle.rst b/sites/docs/api/sftp_handle.rst
new file mode 100644
index 00000000..0f563b16
--- /dev/null
+++ b/sites/docs/api/sftp_handle.rst
@@ -0,0 +1,7 @@
+paramiko.sftp_handle module
+===========================
+
+.. automodule:: paramiko.sftp_handle
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/sftp_server.rst b/sites/docs/api/sftp_server.rst
new file mode 100644
index 00000000..50e84b18
--- /dev/null
+++ b/sites/docs/api/sftp_server.rst
@@ -0,0 +1,7 @@
+paramiko.sftp_server module
+===========================
+
+.. automodule:: paramiko.sftp_server
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/sftp_si.rst b/sites/docs/api/sftp_si.rst
new file mode 100644
index 00000000..e369d879
--- /dev/null
+++ b/sites/docs/api/sftp_si.rst
@@ -0,0 +1,7 @@
+paramiko.sftp_si module
+=======================
+
+.. automodule:: paramiko.sftp_si
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/ssh_exception.rst b/sites/docs/api/ssh_exception.rst
new file mode 100644
index 00000000..a4b6d2aa
--- /dev/null
+++ b/sites/docs/api/ssh_exception.rst
@@ -0,0 +1,7 @@
+paramiko.ssh_exception module
+=============================
+
+.. automodule:: paramiko.ssh_exception
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/transport.rst b/sites/docs/api/transport.rst
new file mode 100644
index 00000000..19fb0e88
--- /dev/null
+++ b/sites/docs/api/transport.rst
@@ -0,0 +1,7 @@
+paramiko.transport module
+=========================
+
+.. automodule:: paramiko.transport
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/util.rst b/sites/docs/api/util.rst
new file mode 100644
index 00000000..ae3eae0f
--- /dev/null
+++ b/sites/docs/api/util.rst
@@ -0,0 +1,7 @@
+paramiko.util module
+====================
+
+.. automodule:: paramiko.util
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/api/win_pageant.rst b/sites/docs/api/win_pageant.rst
new file mode 100644
index 00000000..561a5143
--- /dev/null
+++ b/sites/docs/api/win_pageant.rst
@@ -0,0 +1,7 @@
+paramiko.win_pageant module
+===========================
+
+.. automodule:: paramiko.win_pageant
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/sites/docs/index.rst b/sites/docs/index.rst
index 7ec5825e..89c75831 100644
--- a/sites/docs/index.rst
+++ b/sites/docs/index.rst
@@ -6,4 +6,6 @@ Paramiko is, including its public changelog & how the project is maintained,
please see `the main website <http://paramiko.org>`_.
.. toctree::
- api
+ :glob:
+
+ api/*