[X2Go-Commits] [python-x2go] 02/07: API documentation: Convert full class name path links to reST links.
git-admin at x2go.org
git-admin at x2go.org
Tue Mar 6 20:34:48 CET 2018
This is an automated email from the git hooks/post-receive script.
x2go pushed a commit to branch master
in repository python-x2go.
commit 146ffb45a264c8eb81a412fff6bc42a927bd8d81
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date: Tue Mar 6 17:03:03 2018 +0100
API documentation: Convert full class name path links to reST links.
---
x2go/backends/printing/file.py | 4 ++--
x2go/backends/printing/winreg.py | 4 ++--
x2go/backends/profiles/base.py | 2 +-
x2go/backends/profiles/file.py | 2 +-
x2go/backends/profiles/httpbroker.py | 2 +-
x2go/backends/profiles/sshbroker.py | 2 +-
x2go/backends/proxy/base.py | 4 ++--
x2go/backends/proxy/nx3.py | 4 ++--
x2go/backends/terminal/plain.py | 18 +++++++++---------
9 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/x2go/backends/printing/file.py b/x2go/backends/printing/file.py
index 9f8da1c..ca6cec3 100644
--- a/x2go/backends/printing/file.py
+++ b/x2go/backends/printing/file.py
@@ -66,11 +66,11 @@ _print_property_map = {
class X2GoClientPrinting(inifiles.X2GoIniFile):
"""\
- L{x2go.backends.printing.file.X2GoClientPrinting} provides access to the X2Go ini-like file
+ :class:`x2go.backends.printing.file.X2GoClientPrinting` provides access to the X2Go ini-like file
»printing« as stored in ``~/.x2goclient/printing`` resp. globally
``/etc/x2goclient/printing``.
- An instance of L{x2go.backends.printing.file.X2GoClientPrinting} is created on each incoming
+ An instance of :class:`x2go.backends.printing.file.X2GoClientPrinting` is created on each incoming
print job. This facilitates that on every print job the print action
for this job is derived from the »printing« configuration file.
diff --git a/x2go/backends/printing/winreg.py b/x2go/backends/printing/winreg.py
index ea9ade3..67a4f44 100644
--- a/x2go/backends/printing/winreg.py
+++ b/x2go/backends/printing/winreg.py
@@ -47,10 +47,10 @@ from x2go.x2go_exceptions import X2GoNotImplementedYetException
class X2GoClientPrinting(object):
"""\
- L{x2go.backends.printing.winreg.X2GoClientPrinting} provides access to the Windows registry
+ :class:`x2go.backends.printing.winreg.X2GoClientPrinting` provides access to the Windows registry
based configuration of the X2Go client printing setup.
- An instance of L{x2go.backends.printing.winreg.X2GoClientPrinting} is created on each incoming
+ An instance of :class:`x2go.backends.printing.winreg.X2GoClientPrinting` is created on each incoming
print job. This facilitates that on every print job the print action for this job is derived from the
»printing« configuration file.
diff --git a/x2go/backends/profiles/base.py b/x2go/backends/profiles/base.py
index b41f31c..0cdb142 100644
--- a/x2go/backends/profiles/base.py
+++ b/x2go/backends/profiles/base.py
@@ -57,7 +57,7 @@ class X2GoSessionProfiles(object):
@param session_profile_defaults: a default session profile
@type session_profile_defaults: ``dict``
@param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
- L{x2go.backends.profiles.httpbroker.X2GoSessionProfiles} constructor
+ :class:`x2go.backends.profiles.httpbroker.X2GoSessionProfiles` constructor
@type logger: :class:`x2go.logger.X2GoLogger` instance
@param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be
constructed with the given loglevel
diff --git a/x2go/backends/profiles/file.py b/x2go/backends/profiles/file.py
index 73087a0..72f8185 100644
--- a/x2go/backends/profiles/file.py
+++ b/x2go/backends/profiles/file.py
@@ -48,7 +48,7 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles, inifiles.X2GoIniFile):
:param session_profile_defaults: a default session profile
:type session_profile_defaults: ``dict``
:param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
- L{x2go.backends.profiles.file.X2GoSessionProfiles} constructor
+ :class:`x2go.backends.profiles.file.X2GoSessionProfiles` constructor
:type logger: :class:`x2go.logger.X2GoLogger` instance
:param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be
constructed with the given loglevel
diff --git a/x2go/backends/profiles/httpbroker.py b/x2go/backends/profiles/httpbroker.py
index 147e102..17fb045 100644
--- a/x2go/backends/profiles/httpbroker.py
+++ b/x2go/backends/profiles/httpbroker.py
@@ -69,7 +69,7 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles):
password string in the ``broker_URL`` parameter is highly recommended)
@type broker_password: ``str``
@param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
- L{x2go.backends.profiles.httpbroker.X2GoSessionProfiles} constructor
+ :class:`x2go.backends.profiles.httpbroker.X2GoSessionProfiles` constructor
@type logger: :class:`x2go.logger.X2GoLogger` instance
@param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be
constructed with the given loglevel
diff --git a/x2go/backends/profiles/sshbroker.py b/x2go/backends/profiles/sshbroker.py
index 5974677..27f83d4 100644
--- a/x2go/backends/profiles/sshbroker.py
+++ b/x2go/backends/profiles/sshbroker.py
@@ -52,7 +52,7 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles):
@param session_profile_defaults: a default session profile
@type session_profile_defaults: ``dict``
@param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
- L{x2go.backends.profiles.httpbroker.X2GoSessionProfiles} constructor
+ :class:`x2go.backends.profiles.httpbroker.X2GoSessionProfiles` constructor
@type logger: :class:`x2go.logger.X2GoLogger` instance
@param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be
constructed with the given loglevel
diff --git a/x2go/backends/proxy/base.py b/x2go/backends/proxy/base.py
index 1545594..2db38f9 100644
--- a/x2go/backends/proxy/base.py
+++ b/x2go/backends/proxy/base.py
@@ -56,7 +56,7 @@ class X2GoProxy(threading.Thread):
X2GoProxy is an abstract class for X2Go proxy connections.
This class needs to be inherited from a concrete proxy class. Only
- currently available proxy class is: L{x2go.backends.proxy.nx3.X2GoProxy}.
+ currently available proxy class is: :class:`x2go.backends.proxy.nx3.X2GoProxy`.
"""
PROXY_CMD = ''
@@ -256,7 +256,7 @@ class X2GoProxy(threading.Thread):
1. remove processed proxy_options from self.proxy_options
2. once you have finished processing the proxy_options call
- the parent class method L{x2go.backends.proxy.base.X2GoProxy.process_proxy_options()}
+ the parent class method :class:`x2go.backends.proxy.base.X2GoProxy.process_proxy_options()`
"""
# do the logging of remaining options
diff --git a/x2go/backends/proxy/nx3.py b/x2go/backends/proxy/nx3.py
index 0162880..42d02c8 100644
--- a/x2go/backends/proxy/nx3.py
+++ b/x2go/backends/proxy/nx3.py
@@ -39,14 +39,14 @@ class X2GoProxy(base.X2GoProxy):
"""\
This :class:`x2go.backends.proxy.nx3.X2GoProxy` class is a NX version 3 based X2Go proxy connection class.
- It basically fills L{x2go.backends.proxy.base.X2GoProxy} variables with sensible content. Its
+ It basically fills :class:`x2go.backends.proxy.base.X2GoProxy` variables with sensible content. Its
methods mostly wrap around the corresponding methods of the parent class.
"""
def __init__(self, *args, **kwargs):
"""\
- For available parameters refer to L{x2go.backends.proxy.base.X2GoProxy} class documentation.
+ For available parameters refer to :class:`x2go.backends.proxy.base.X2GoProxy` class documentation.
"""
base.X2GoProxy.__init__(self, *args, **kwargs)
diff --git a/x2go/backends/terminal/plain.py b/x2go/backends/terminal/plain.py
index 986b0e4..5029545 100644
--- a/x2go/backends/terminal/plain.py
+++ b/x2go/backends/terminal/plain.py
@@ -191,11 +191,11 @@ class X2GoTerminalSession(object):
"""\
Class for managing X2Go terminal sessions on a remote X2Go server via Paramiko/SSH.
- With the L{x2go.backends.terminal.plain.X2GoTerminalSession} class you can start new X2Go sessions, resume suspended
+ With the :class:`x2go.backends.terminal.plain.X2GoTerminalSession` class you can start new X2Go sessions, resume suspended
sessions or suspend resp. terminate currently running sessions on a
connected X2Go server.
- An L{x2go.backends.terminal.plain.X2GoTerminalSession} object uses two main data structure classes:
+ An :class:`x2go.backends.terminal.plain.X2GoTerminalSession` object uses two main data structure classes:
- :class:`x2go.backends.terminal.plain.X2GoSessionParams`: stores all parameters that have been passed to the
constructor method.
@@ -204,7 +204,7 @@ class X2GoTerminalSession(object):
will be used to store all information retrieved from the X2Go server.
The terminal session instance works closely together (i.e. depends on) a connected control
- session instance (e.g. L{x2go.backends.control.plain.X2GoControlSession}). You never should use either of them as a standalone
+ session instance (e.g. :class:`x2go.backends.control.plain.X2GoControlSession`). You never should use either of them as a standalone
instance. Both, control session and terminal session(s) get managed/controlled via :class:`x2go.session.X2GoSession` instances.
@@ -232,7 +232,7 @@ class X2GoTerminalSession(object):
session_instance=None,
logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- Initialize an X2Go session. With the L{x2go.backends.terminal.plain.X2GoTerminalSession} class you can start
+ Initialize an X2Go session. With the :class:`x2go.backends.terminal.plain.X2GoTerminalSession` class you can start
new X2Go sessions, resume suspended sessions or suspend resp. terminate
currently running sessions on a connected X2Go server.
@@ -247,7 +247,7 @@ class X2GoTerminalSession(object):
@type pack: ``str``
@param dpi: dots-per-inch value for the session screen (has an impact on the font size on screen)
@type dpi: ``str``
- @param cache_type: a dummy parameter that is passed to the L{x2go.backends.proxy.base.X2GoProxy}. In NX Proxy
+ @param cache_type: a dummy parameter that is passed to the :class:`x2go.backends.proxy.base.X2GoProxy`. In NX Proxy
(class ``X2GoProxyNX3``) this originally is the session name. With X2Go it
defines the name of the NX cache directory. Best is to leave it untouched.
@type cache_type: ``str``
@@ -268,7 +268,7 @@ class X2GoTerminalSession(object):
@param snd_port: local sound port for network capable audio system
@type snd_port: ``int``
@param cmd: command to be run on X2Go server after session start (only used
- when L{x2go.backends.terminal.plain.X2GoTerminalSession.start()} is called, ignored on resume, suspend etc.
+ when :class:`x2go.backends.terminal.plain.X2GoTerminalSession.start()` is called, ignored on resume, suspend etc.
@type cmd: ``str``
@param published_applications: session is published applications provider
@type published_applications: ``bool``
@@ -318,7 +318,7 @@ class X2GoTerminalSession(object):
@param session_instance: the :class:`x2go.session.X2GoSession` instance that is parent to this terminal session
@type session_instance: ``obj``
@param logger: you can pass an :class:`x2go.logger.X2GoLogger` object to the
- L{x2go.backends.terminal.plain.X2GoTerminalSession} constructor
+ :class:`x2go.backends.terminal.plain.X2GoTerminalSession` constructor
@type logger: :class:`x2go.logger.X2GoLogger` instance
@param loglevel: if no :class:`x2go.logger.X2GoLogger` object has been supplied a new one will be
constructed with the given loglevel
@@ -1279,8 +1279,8 @@ class X2GoTerminalSession(object):
"""\
Run a command in this session.
- After L{x2go.backends.terminal.plain.X2GoTerminalSession.start()} has been called
- one or more commands can be executed with L{x2go.backends.terminal.plain.X2GoTerminalSession.run_command()}
+ After :class:`x2go.backends.terminal.plain.X2GoTerminalSession.start()` has been called
+ one or more commands can be executed with :class:`x2go.backends.terminal.plain.X2GoTerminalSession.run_command()`
within the current X2Go session.
:param cmd: Command to be run (Default value = None)
--
Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/python-x2go.git
More information about the x2go-commits
mailing list