setuptools-scm.rtfd.io

The tables below list all intersphinx cross-reference targets available from this site. To use any of these targets in your own Sphinx documentation, add the site URL to your intersphinx_mapping and then use the Usage example column value directly in your .rst or .md source files.

https://setuptools-scm.rtfd.io/latest

py:class

Identifier Project Name Version Location Display Name Usage example
vcs_versioning.Configuration setuptools scm 0.0.0 config/#vcs_versioning.Configuration :py:class:`vcs_versioning.Configuration`
vcs_versioning.NonNormalizedVersion setuptools scm 0.0.0 customizing/#vcs_versioning.NonNormalizedVersion :py:class:`vcs_versioning.NonNormalizedVersion`
vcs_versioning.ScmVersion setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion :py:class:`vcs_versioning.ScmVersion`
vcs_versioning._config.Configuration setuptools scm 0.0.0 config/#vcs_versioning.Configuration :py:class:`vcs_versioning._config.Configuration`
vcs_versioning._entrypoints.Configuration setuptools scm 0.0.0 config/#vcs_versioning.Configuration :py:class:`vcs_versioning._entrypoints.Configuration`
vcs_versioning._entrypoints.ScmVersion setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion :py:class:`vcs_versioning._entrypoints.ScmVersion`
vcs_versioning._exceptions.DirtyWorkingTreeError setuptools scm 0.0.0 extending/#vcs_versioning._version_schemes.DirtyWorkingTreeError :py:class:`vcs_versioning._exceptions.DirtyWorkingTreeError`
vcs_versioning._integrator_helpers.Configuration setuptools scm 0.0.0 config/#vcs_versioning.Configuration :py:class:`vcs_versioning._integrator_helpers.Configuration`
vcs_versioning._scm_version.ScmVersion setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion :py:class:`vcs_versioning._scm_version.ScmVersion`
vcs_versioning._types.ScmVersion setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion :py:class:`vcs_versioning._types.ScmVersion`
vcs_versioning._version_cls.NonNormalizedVersion setuptools scm 0.0.0 customizing/#vcs_versioning.NonNormalizedVersion :py:class:`vcs_versioning._version_cls.NonNormalizedVersion`
vcs_versioning._version_schemes.DirtyWorkingTreeError setuptools scm 0.0.0 extending/#vcs_versioning._version_schemes.DirtyWorkingTreeError :py:class:`vcs_versioning._version_schemes.DirtyWorkingTreeError`
vcs_versioning._version_schemes.ScmVersion setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion :py:class:`vcs_versioning._version_schemes.ScmVersion`

py:function

Identifier Project Name Version Location Display Name Usage example
vcs_versioning.Configuration.discover_workdir setuptools scm 0.0.0 config/#vcs_versioning.Configuration.discover_workdir :py:function:`vcs_versioning.Configuration.discover_workdir`
vcs_versioning.Configuration.from_data setuptools scm 0.0.0 config/#vcs_versioning.Configuration.from_data :py:function:`vcs_versioning.Configuration.from_data`
vcs_versioning.Configuration.from_file setuptools scm 0.0.0 config/#vcs_versioning.Configuration.from_file :py:function:`vcs_versioning.Configuration.from_file`
vcs_versioning.ScmVersion.format setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.format :py:function:`vcs_versioning.ScmVersion.format`
vcs_versioning.ScmVersion.format_choice setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.format_choice :py:function:`vcs_versioning.ScmVersion.format_choice`
vcs_versioning.ScmVersion.format_with setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.format_with :py:function:`vcs_versioning.ScmVersion.format_with`
vcs_versioning.ScmVersion.matches setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.matches :py:function:`vcs_versioning.ScmVersion.matches`
vcs_versioning._config.Configuration.discover_workdir setuptools scm 0.0.0 config/#vcs_versioning.Configuration.discover_workdir :py:function:`vcs_versioning._config.Configuration.discover_workdir`
vcs_versioning._config.Configuration.from_data setuptools scm 0.0.0 config/#vcs_versioning.Configuration.from_data :py:function:`vcs_versioning._config.Configuration.from_data`
vcs_versioning._config.Configuration.from_file setuptools scm 0.0.0 config/#vcs_versioning.Configuration.from_file :py:function:`vcs_versioning._config.Configuration.from_file`
vcs_versioning._scm_version.ScmVersion.format setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.format :py:function:`vcs_versioning._scm_version.ScmVersion.format`
vcs_versioning._scm_version.ScmVersion.format_choice setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.format_choice :py:function:`vcs_versioning._scm_version.ScmVersion.format_choice`
vcs_versioning._scm_version.ScmVersion.format_with setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.format_with :py:function:`vcs_versioning._scm_version.ScmVersion.format_with`
vcs_versioning._scm_version.ScmVersion.matches setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.matches :py:function:`vcs_versioning._scm_version.ScmVersion.matches`
vcs_versioning._scm_version.meta setuptools scm 0.0.0 extending/#vcs_versioning._version_schemes.meta :py:function:`vcs_versioning._scm_version.meta`
vcs_versioning._version_schemes.meta setuptools scm 0.0.0 extending/#vcs_versioning._version_schemes.meta :py:function:`vcs_versioning._version_schemes.meta`

py:attr

Identifier Project Name Version Location Display Name Usage example
vcs_versioning.Configuration.env setuptools scm 0.0.0 config/#vcs_versioning.Configuration.env :py:attr:`vcs_versioning.Configuration.env`
vcs_versioning.Configuration.write_to_source setuptools scm 0.0.0 config/#vcs_versioning.Configuration.write_to_source :py:attr:`vcs_versioning.Configuration.write_to_source`
vcs_versioning.ScmVersion.branch setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.branch :py:attr:`vcs_versioning.ScmVersion.branch`
vcs_versioning.ScmVersion.config setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.config :py:attr:`vcs_versioning.ScmVersion.config`
vcs_versioning.ScmVersion.dirty setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.dirty :py:attr:`vcs_versioning.ScmVersion.dirty`
vcs_versioning.ScmVersion.distance setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.distance :py:attr:`vcs_versioning.ScmVersion.distance`
vcs_versioning.ScmVersion.exact setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.exact :py:attr:`vcs_versioning.ScmVersion.exact`
vcs_versioning.ScmVersion.node setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.node :py:attr:`vcs_versioning.ScmVersion.node`
vcs_versioning.ScmVersion.node_date setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.node_date :py:attr:`vcs_versioning.ScmVersion.node_date`
vcs_versioning.ScmVersion.preformatted setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.preformatted :py:attr:`vcs_versioning.ScmVersion.preformatted`
vcs_versioning.ScmVersion.short_node setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.short_node :py:attr:`vcs_versioning.ScmVersion.short_node`
vcs_versioning.ScmVersion.tag setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.tag :py:attr:`vcs_versioning.ScmVersion.tag`
vcs_versioning.ScmVersion.time setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.time :py:attr:`vcs_versioning.ScmVersion.time`
vcs_versioning._config.Configuration.env setuptools scm 0.0.0 config/#vcs_versioning.Configuration.env :py:attr:`vcs_versioning._config.Configuration.env`
vcs_versioning._config.Configuration.write_to_source setuptools scm 0.0.0 config/#vcs_versioning.Configuration.write_to_source :py:attr:`vcs_versioning._config.Configuration.write_to_source`
vcs_versioning._scm_version.ScmVersion.branch setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.branch :py:attr:`vcs_versioning._scm_version.ScmVersion.branch`
vcs_versioning._scm_version.ScmVersion.config setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.config :py:attr:`vcs_versioning._scm_version.ScmVersion.config`
vcs_versioning._scm_version.ScmVersion.dirty setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.dirty :py:attr:`vcs_versioning._scm_version.ScmVersion.dirty`
vcs_versioning._scm_version.ScmVersion.distance setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.distance :py:attr:`vcs_versioning._scm_version.ScmVersion.distance`
vcs_versioning._scm_version.ScmVersion.exact setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.exact :py:attr:`vcs_versioning._scm_version.ScmVersion.exact`
vcs_versioning._scm_version.ScmVersion.node setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.node :py:attr:`vcs_versioning._scm_version.ScmVersion.node`
vcs_versioning._scm_version.ScmVersion.node_date setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.node_date :py:attr:`vcs_versioning._scm_version.ScmVersion.node_date`
vcs_versioning._scm_version.ScmVersion.preformatted setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.preformatted :py:attr:`vcs_versioning._scm_version.ScmVersion.preformatted`
vcs_versioning._scm_version.ScmVersion.short_node setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.short_node :py:attr:`vcs_versioning._scm_version.ScmVersion.short_node`
vcs_versioning._scm_version.ScmVersion.tag setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.tag :py:attr:`vcs_versioning._scm_version.ScmVersion.tag`
vcs_versioning._scm_version.ScmVersion.time setuptools scm 0.0.0 extending/#vcs_versioning.ScmVersion.time :py:attr:`vcs_versioning._scm_version.ScmVersion.time`

py:data

Identifier Project Name Version Location Display Name Usage example
vcs_versioning._backends._git.DEFAULT_DESCRIBE setuptools scm 0.0.0 config/#vcs_versioning._backends._git.DEFAULT_DESCRIBE :py:data:`vcs_versioning._backends._git.DEFAULT_DESCRIBE`
vcs_versioning._config.DEFAULT_TAG_REGEX setuptools scm 0.0.0 config/#vcs_versioning._config.DEFAULT_TAG_REGEX :py:data:`vcs_versioning._config.DEFAULT_TAG_REGEX`