[Pkg-privacy-commits] [pyptlib] 100/136: add links to full module docs

Ximin Luo infinity0 at moszumanska.debian.org
Sat Aug 22 13:25:15 UTC 2015


This is an automated email from the git hooks/post-receive script.

infinity0 pushed a commit to branch master
in repository pyptlib.

commit 1b61d20d544a488ecb7d509cedbfda6488f38d05
Author: Ximin Luo <infinity0 at gmx.com>
Date:   Thu Sep 5 18:19:45 2013 +0100

    add links to full module docs
---
 sphinx/API.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/sphinx/API.rst b/sphinx/API.rst
index f356217..faec774 100644
--- a/sphinx/API.rst
+++ b/sphinx/API.rst
@@ -89,6 +89,9 @@ Proceeding with the previous example:
    if 'rot26' in client.getTransports():
        launch_rot26_client()
 
+For a full list of the methods available, see the module docs for :class:`client
+<pyptlib.client.ClientTransportPlugin>` and :class:`client.config
+<pyptlib.client_config.ClientConfig>`.
 
 .. note:: Since the application runs as a client, it should launch a
           SOCKS server in the upstream side of the proxy.
@@ -115,6 +118,10 @@ Proceeding with the previous example:
    if 'rot26' in transports:
        launch_rot26_server(transports['rot26'], server.config.getORPort())
 
+For a full list of the methods available, see the module docs for :class:`server
+<pyptlib.server.ServerTransportPlugin>` and :class:`server.config
+<pyptlib.server_config.ServerConfig>`.
+
 3) Report results back to Tor.
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/pyptlib.git



More information about the Pkg-privacy-commits mailing list