diff --git a/sites/docs/api.rst b/sites/docs/api.rst deleted file mode 100644 index 4761570..0000000 --- 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 0000000..cb966f2 --- /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 0000000..c35f5b6 --- /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 0000000..3627528 --- /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 0000000..57411fc --- /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 0000000..8584848 --- /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 0000000..5017137 --- /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 0000000..0abcf98 --- /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 0000000..9089efb --- /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 0000000..fb58795 --- /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 0000000..67fbd84 --- /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 0000000..044ceab --- /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 0000000..0428fa9 --- /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 0000000..749853b --- /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 0000000..8bef58d --- /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 0000000..55c1788 --- /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 0000000..4f7b583 --- /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 0000000..6a127d7 --- /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 0000000..5ec75fa --- /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 0000000..fb75e66 --- /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 0000000..8dfe2a4 --- /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 0000000..5a0f5af --- /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 0000000..a4527ab --- /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 0000000..7ad995c --- /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 0000000..3821c9b --- /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 0000000..1d65900 --- /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 0000000..114748c --- /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 0000000..ee973df --- /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 0000000..7775680 --- /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 0000000..0f563b1 --- /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 0000000..50e84b1 --- /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 0000000..e369d87 --- /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 0000000..a4b6d2a --- /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 0000000..19fb0e8 --- /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 0000000..ae3eae0 --- /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 0000000..561a514 --- /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 7ec5825..89c7583 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 `_. .. toctree:: - api + :glob: + + api/*