summaryrefslogtreecommitdiffhomepage
path: root/sites/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'sites/docs/index.rst')
-rw-r--r--sites/docs/index.rst43
1 files changed, 41 insertions, 2 deletions
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