finesse.utilities.docs module

finesse.utilities.docs.class_to_url(cls: type) → str[source]

Get the api page for a finesse class. Always points to the latest release version

Parameters

clstype: A class defined in Finesse

Returns

str: The url to the api documentation page

finesse.utilities.docs.get_docs_url() → str[source]

Retrieves the documentation URL from the Finesse package metadata

Returns

str: documentation url