flumotion.common.documentation

Module documentation

creating links to online/installed documentation. Integration with online and installed documentation for messages.

Version: $Rev: 6125 $

Functions

getMessageWebLink(message)
Get the on-line documentation link target for this message, if any.

source code

string

getWebLink(section, anchor, version=None, projectURL=None)
Get a documentation link based on the parameters.

source code

messageAddPythonInstall(message, moduleName)
Add text and link on how to install the given python module to the given message.

source code

messageAddFixBadPermissions(message)
Add link on how to change device permissions on Linux.

source code

messageAddGStreamerInstall(message)
Add text and link on how to install the given python module to the given message.

source code

Variables

__package__ = None
hash(x)

Function Details

Get the on-line documentation link target for this message, if any.

Parameters:

Get a documentation link based on the parameters.

Parameters:

section (string) - section, usually the name of the html file
anchor (string) - name of the anchor, part of a section
version (string @param projectURL, url for the project this link belongs to.) - optional, version to use. If this is not specified the version from configure.version will be used
projectURL (string)

Returns: string

the constructed documentation link