Package epydoc :: Package docwriter :: Module xlink :: Class VoidUrlGenerator

[frames] | no frames]

Class VoidUrlGenerator

source code

Don't actually know any url, but don't report any error.

Useful if an index file is not available, but a document linking to it is to be generated, and warnings are to be avoided.

Don't report any object as missing, Don't return any url anyway.

Nested Classes

Inherited from UrlGenerator: IndexAmbiguous

Instance Methods

str

get_url(self, name)
Look for a name and return the matching URL documentation.

source code

Inherited from UrlGenerator: get_canonical_name

Class Variables

Inherited from UrlGenerator (private): _SEP_RE

Method Details

get_url(self, name)

Look for a name and return the matching URL documentation.

First look for a fully qualified name. If not found, try with partial name.

If no url exists for the given object, return None.

Returns: str: the URL that can be used to reach the name documentation. None if no such URL exists.
Overrides: UrlGenerator.get_url: (inherited documentation)