From b140b29d542e9a0ee1d5c013e3612b8a16ca851b Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 12:09:59 -0800 Subject: Hook API doc into index/toctree --- sites/docs/index.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'sites/docs/index.rst') diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 08b34320..7ec5825e 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -4,3 +4,6 @@ Welcome to Paramiko's documentation! This site covers Paramiko's usage & API documentation. For basic info on what Paramiko is, including its public changelog & how the project is maintained, please see `the main website `_. + +.. toctree:: + api -- cgit v1.2.3 From 2346f1a1e937f39343c2805d098b52f6c87f8fc9 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 13:33:22 -0800 Subject: Swap out all-in-one file with sphinx-apidoc generated stuff --- sites/docs/api.rst | 8 -------- sites/docs/api/agent.rst | 7 +++++++ sites/docs/api/auth_handler.rst | 7 +++++++ sites/docs/api/ber.rst | 7 +++++++ sites/docs/api/buffered_pipe.rst | 7 +++++++ sites/docs/api/channel.rst | 7 +++++++ sites/docs/api/client.rst | 7 +++++++ sites/docs/api/common.rst | 7 +++++++ sites/docs/api/compress.rst | 7 +++++++ sites/docs/api/config.rst | 7 +++++++ sites/docs/api/dsskey.rst | 7 +++++++ sites/docs/api/file.rst | 7 +++++++ sites/docs/api/hostkeys.rst | 7 +++++++ sites/docs/api/kex_gex.rst | 7 +++++++ sites/docs/api/kex_group1.rst | 7 +++++++ sites/docs/api/logging22.rst | 7 +++++++ sites/docs/api/message.rst | 7 +++++++ sites/docs/api/packet.rst | 7 +++++++ sites/docs/api/pipe.rst | 7 +++++++ sites/docs/api/pkey.rst | 7 +++++++ sites/docs/api/primes.rst | 7 +++++++ sites/docs/api/proxy.rst | 7 +++++++ sites/docs/api/resource.rst | 7 +++++++ sites/docs/api/rsakey.rst | 7 +++++++ sites/docs/api/server.rst | 7 +++++++ sites/docs/api/sftp.rst | 7 +++++++ sites/docs/api/sftp_attr.rst | 7 +++++++ sites/docs/api/sftp_client.rst | 7 +++++++ sites/docs/api/sftp_file.rst | 7 +++++++ sites/docs/api/sftp_handle.rst | 7 +++++++ sites/docs/api/sftp_server.rst | 7 +++++++ sites/docs/api/sftp_si.rst | 7 +++++++ sites/docs/api/ssh_exception.rst | 7 +++++++ sites/docs/api/transport.rst | 7 +++++++ sites/docs/api/util.rst | 7 +++++++ sites/docs/api/win_pageant.rst | 7 +++++++ sites/docs/index.rst | 4 +++- 37 files changed, 248 insertions(+), 9 deletions(-) delete mode 100644 sites/docs/api.rst create mode 100644 sites/docs/api/agent.rst create mode 100644 sites/docs/api/auth_handler.rst create mode 100644 sites/docs/api/ber.rst create mode 100644 sites/docs/api/buffered_pipe.rst create mode 100644 sites/docs/api/channel.rst create mode 100644 sites/docs/api/client.rst create mode 100644 sites/docs/api/common.rst create mode 100644 sites/docs/api/compress.rst create mode 100644 sites/docs/api/config.rst create mode 100644 sites/docs/api/dsskey.rst create mode 100644 sites/docs/api/file.rst create mode 100644 sites/docs/api/hostkeys.rst create mode 100644 sites/docs/api/kex_gex.rst create mode 100644 sites/docs/api/kex_group1.rst create mode 100644 sites/docs/api/logging22.rst create mode 100644 sites/docs/api/message.rst create mode 100644 sites/docs/api/packet.rst create mode 100644 sites/docs/api/pipe.rst create mode 100644 sites/docs/api/pkey.rst create mode 100644 sites/docs/api/primes.rst create mode 100644 sites/docs/api/proxy.rst create mode 100644 sites/docs/api/resource.rst create mode 100644 sites/docs/api/rsakey.rst create mode 100644 sites/docs/api/server.rst create mode 100644 sites/docs/api/sftp.rst create mode 100644 sites/docs/api/sftp_attr.rst create mode 100644 sites/docs/api/sftp_client.rst create mode 100644 sites/docs/api/sftp_file.rst create mode 100644 sites/docs/api/sftp_handle.rst create mode 100644 sites/docs/api/sftp_server.rst create mode 100644 sites/docs/api/sftp_si.rst create mode 100644 sites/docs/api/ssh_exception.rst create mode 100644 sites/docs/api/transport.rst create mode 100644 sites/docs/api/util.rst create mode 100644 sites/docs/api/win_pageant.rst (limited to 'sites/docs/index.rst') 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 `_. .. toctree:: - api + :glob: + + api/* -- cgit v1.2.3 From 0af6df924add72313594c12418d0a2cb45291e4a Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 14 Feb 2014 18:20:47 -0800 Subject: First stab at segmented TOCtrees. Makes sidebar TOC a little funny tho. --- sites/docs/api/transport.rst | 4 ++-- sites/docs/index.rst | 43 +++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 43 insertions(+), 4 deletions(-) (limited to 'sites/docs/index.rst') diff --git a/sites/docs/api/transport.rst b/sites/docs/api/transport.rst index f68b77dc..1b54f04e 100644 --- a/sites/docs/api/transport.rst +++ b/sites/docs/api/transport.rst @@ -1,4 +1,4 @@ -Transport (core protocol) -========================= +Transport +========= .. automodule:: paramiko.transport diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 89c75831..bca0e650 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -5,7 +5,46 @@ This site covers Paramiko's usage & API documentation. For basic info on what Paramiko is, including its public changelog & how the project is maintained, please see `the main website `_. + +API documentation +================= + +Core SSH protocol classes +------------------------- + +.. toctree:: + api/channel + api/client + api/message + api/packet + api/transport + + +Authentication & key handling +----------------------------- + .. toctree:: - :glob: + api/agent + api/hostkeys + api/keys + api/win_pageant - api/* + +Other primary functions +----------------------- + +.. toctree:: + api/config + api/proxy + api/server + api/sftp + + +Miscellany +---------- + +.. toctree:: + api/buffered_pipe + api/file + api/pipe + api/ssh_exception -- cgit v1.2.3 From a58cf80139ff0c8059eebe8bd0c55963a5a33f53 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 09:56:14 -0800 Subject: Un-derp header levels --- sites/docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'sites/docs/index.rst') diff --git a/sites/docs/index.rst b/sites/docs/index.rst index bca0e650..5133c244 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -1,3 +1,4 @@ +==================================== Welcome to Paramiko's documentation! ==================================== -- cgit v1.2.3 From 88140996a7a259e9e028b022c037223ee97c4c87 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 09:58:19 -0800 Subject: Too much 'handling' --- sites/docs/api/config.rst | 4 ++-- sites/docs/api/hostkeys.rst | 4 ++-- sites/docs/index.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) (limited to 'sites/docs/index.rst') diff --git a/sites/docs/api/config.rst b/sites/docs/api/config.rst index 0a9fa1dc..6f9d3ce3 100644 --- a/sites/docs/api/config.rst +++ b/sites/docs/api/config.rst @@ -1,4 +1,4 @@ -Configuration handling -====================== +Configuration +============= .. automodule:: paramiko.config diff --git a/sites/docs/api/hostkeys.rst b/sites/docs/api/hostkeys.rst index b57a2c6c..0859fbed 100644 --- a/sites/docs/api/hostkeys.rst +++ b/sites/docs/api/hostkeys.rst @@ -1,4 +1,4 @@ -Host key / known_hosts handling -=============================== +Host keys / ``known_hosts`` files +================================= .. automodule:: paramiko.hostkeys diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 5133c244..98f4069a 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -21,8 +21,8 @@ Core SSH protocol classes api/transport -Authentication & key handling ------------------------------ +Authentication & keys +--------------------- .. toctree:: api/agent -- cgit v1.2.3 From 0e9a5a4b463fbbc8518e4679850207e31fbd8a0f Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 14:31:08 -0800 Subject: Move module level docstring into Sphinx docs --- paramiko/__init__.py | 32 -------------------------------- sites/docs/index.rst | 22 ++++++++++++++++++++++ 2 files changed, 22 insertions(+), 32 deletions(-) (limited to 'sites/docs/index.rst') diff --git a/paramiko/__init__.py b/paramiko/__init__.py index 6e282c63..bfd28f26 100644 --- a/paramiko/__init__.py +++ b/paramiko/__init__.py @@ -16,38 +16,6 @@ # along with Paramiko; if not, write to the Free Software Foundation, Inc., # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. -""" -Paramiko (a combination of the esperanto words for "paranoid" and "friend") -is a module for python 2.5 or greater that implements the SSH2 protocol for -secure (encrypted and authenticated) connections to remote machines. Unlike -SSL (aka TLS), the SSH2 protocol does not require hierarchical certificates -signed by a powerful central authority. You may know SSH2 as the protocol that -replaced ``telnet`` and ``rsh`` for secure access to remote shells, but the -protocol also includes the ability to open arbitrary channels to remote -services across an encrypted tunnel. (This is how ``sftp`` works, for example.) - -The high-level client API starts with creation of an `.SSHClient` object. -For more direct control, pass a socket (or socket-like object) to a -`.Transport`, and use `start_server <.Transport.start_server>` or -`start_client <.Transport.start_client>` to negoatite -with the remote host as either a server or client. As a client, you are -responsible for authenticating using a password or private key, and checking -the server's host key. (Key signature and verification is done by paramiko, -but you will need to provide private keys and check that the content of a -public key matches what you expected to see.) As a server, you are -responsible for deciding which users, passwords, and keys to allow, and what -kind of channels to allow. - -Once you have finished, either side may request flow-controlled `channels ` -to the other side, which are python objects that act like sockets, but send and -receive data over the encrypted session. - -Paramiko is written entirely in python (no C or platform-dependent code) and is -released under the GNU Lesser General Public License (LGPL). - -Website: https://github.com/paramiko/paramiko/ -""" - import sys if sys.version_info < (2, 5): diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 98f4069a..87a0f994 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -10,6 +10,28 @@ please see `the main website `_. API documentation ================= +The high-level client API starts with creation of an `.SSHClient` object. For +more direct control, pass a socket (or socket-like object) to a `.Transport`, +and use `start_server <.Transport.start_server>` or `start_client +<.Transport.start_client>` to negotiate with the remote host as either a server +or client. + +As a client, you are responsible for authenticating using a password or private +key, and checking the server's host key. (Key signature and verification is +done by paramiko, but you will need to provide private keys and check that the +content of a public key matches what you expected to see.) + +As a server, you are responsible for deciding which users, passwords, and keys +to allow, and what kind of channels to allow. + +Once you have finished, either side may request flow-controlled `channels +<.Channel>` to the other side, which are Python objects that act like sockets, +but send and receive data over the encrypted session. + +For details, please see the following tables of contents (which are organized +by area of interest.) + + Core SSH protocol classes ------------------------- -- cgit v1.2.3 From 6d9b28c56c81c2d4eb7452f0d986e4e4ec6c3039 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Fri, 21 Feb 2014 16:56:13 -0800 Subject: Remove win_pageant from docs for now :( too many freakin errors --- sites/docs/api/win_pageant.rst | 4 ---- sites/docs/index.rst | 1 - 2 files changed, 5 deletions(-) delete mode 100644 sites/docs/api/win_pageant.rst (limited to 'sites/docs/index.rst') diff --git a/sites/docs/api/win_pageant.rst b/sites/docs/api/win_pageant.rst deleted file mode 100644 index c48da5c6..00000000 --- a/sites/docs/api/win_pageant.rst +++ /dev/null @@ -1,4 +0,0 @@ -WinPageant support -================== - -.. automodule:: paramiko.win_pageant diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 87a0f994..9e682bb0 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -50,7 +50,6 @@ Authentication & keys api/agent api/hostkeys api/keys - api/win_pageant Other primary functions -- cgit v1.2.3