diff options
| author | Jeff Forcier <jeff@bitprophet.org> | 2014-02-14 18:20:47 -0800 |
|---|---|---|
| committer | Jeff Forcier <jeff@bitprophet.org> | 2014-02-14 18:20:47 -0800 |
| commit | 0af6df924add72313594c12418d0a2cb45291e4a (patch) | |
| tree | 624c8d02667802ccbfb85f1acc7117083b4d3b95 /sites/docs | |
| parent | 22766e96a65106cf8a3107bf432c0b8eb40cb681 (diff) | |
First stab at segmented TOCtrees.
Makes sidebar TOC a little funny tho.
Diffstat (limited to 'sites/docs')
| -rw-r--r-- | sites/docs/api/transport.rst | 4 | ||||
| -rw-r--r-- | sites/docs/index.rst | 43 |
2 files changed, 43 insertions, 4 deletions
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 <http://paramiko.org>`_. + +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 |