Skip to main content

get_docs_version

Returns the documentation version string, mapping non-final releases to 'dev' and final releases to a 'major.minor' format based on the provided or current version.

def get_docs_version(
version: tuple = None
) - > string

Determines the documentation version string based on a version tuple. Returns "dev" for non-final releases or a major.minor string for stable releases.

Parameters

NameTypeDescription
versiontuple = NoneA version tuple containing major, minor, micro, release level, and serial; if None, the current system version is used.

Returns

TypeDescription
stringThe documentation version identifier, either "dev" for pre-releases or a "major.minor" string for final releases.