From a935505b0ad0664f74d07433db40449592a86bf6 Mon Sep 17 00:00:00 2001 From: Sebastian Deiss Date: Thu, 27 Mar 2014 11:14:54 +0100 Subject: Change GSS-API epydoc docstrings to Sphinx --- sites/docs/api/ssh_gss.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 sites/docs/api/ssh_gss.rst (limited to 'sites/docs/api/ssh_gss.rst') diff --git a/sites/docs/api/ssh_gss.rst b/sites/docs/api/ssh_gss.rst new file mode 100644 index 00000000..1b08c7f8 --- /dev/null +++ b/sites/docs/api/ssh_gss.rst @@ -0,0 +1,14 @@ +Paramiko GSS-API Interface +========================== + +.. automodule:: paramiko.ssh_gss + :member-order: bysource + +.. autoclass:: _SSH_GSSAuth + :member-order: bysource + +.. autoclass:: _SSH_GSSAPI + :member-order: bysource + +.. autoclass:: _SSH_SSPI + :member-order: bysource -- cgit v1.2.3 From 67810da14504bd4b4be60f8cb3067d4d6b46abdf Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 8 Sep 2014 16:48:47 -0700 Subject: Tweak API stub titles --- sites/docs/api/kex_gss.rst | 2 +- sites/docs/api/ssh_gss.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'sites/docs/api/ssh_gss.rst') diff --git a/sites/docs/api/kex_gss.rst b/sites/docs/api/kex_gss.rst index 67c7a9a4..9fd09221 100644 --- a/sites/docs/api/kex_gss.rst +++ b/sites/docs/api/kex_gss.rst @@ -1,4 +1,4 @@ -GSS-API Key Exchange +GSS-API key exchange ==================== .. automodule:: paramiko.kex_gss diff --git a/sites/docs/api/ssh_gss.rst b/sites/docs/api/ssh_gss.rst index 1b08c7f8..1ce9daf7 100644 --- a/sites/docs/api/ssh_gss.rst +++ b/sites/docs/api/ssh_gss.rst @@ -1,5 +1,5 @@ -Paramiko GSS-API Interface -========================== +GSS-API interface +================= .. automodule:: paramiko.ssh_gss :member-order: bysource -- cgit v1.2.3 From 6e91d103e8e6c618f1c514638bd2e7243e0e3767 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 8 Sep 2014 16:50:47 -0700 Subject: Reinstate working seealso's --- paramiko/kex_gss.py | 2 ++ paramiko/ssh_gss.py | 2 ++ sites/docs/api/ssh_gss.rst | 4 ++-- 3 files changed, 6 insertions(+), 2 deletions(-) (limited to 'sites/docs/api/ssh_gss.rst') diff --git a/paramiko/kex_gss.py b/paramiko/kex_gss.py index 9669f86a..cdb18496 100644 --- a/paramiko/kex_gss.py +++ b/paramiko/kex_gss.py @@ -24,6 +24,8 @@ This module provides GSS-API / SSPI Key Exchange as defined in RFC 4462. .. note:: Credential delegation is not supported in server mode. + +.. seealso:: :doc:`/api/ssh_gss` """ diff --git a/paramiko/ssh_gss.py b/paramiko/ssh_gss.py index 1d179025..2fdde227 100644 --- a/paramiko/ssh_gss.py +++ b/paramiko/ssh_gss.py @@ -23,6 +23,8 @@ This module provides GSS-API / SSPI authentication as defined in RFC 4462. .. note:: Credential delegation is not supported in server mode. + +.. seealso:: :doc:`/api/kex_gss` """ import struct diff --git a/sites/docs/api/ssh_gss.rst b/sites/docs/api/ssh_gss.rst index 1ce9daf7..7a687e11 100644 --- a/sites/docs/api/ssh_gss.rst +++ b/sites/docs/api/ssh_gss.rst @@ -1,5 +1,5 @@ -GSS-API interface -================= +GSS-API authentication +====================== .. automodule:: paramiko.ssh_gss :member-order: bysource -- cgit v1.2.3