Skip to content

Commit 18d78a8

Browse files
Fix documentation references for split codebase
Update all documentation to reference vcs_versioning modules: - Change setuptools_scm._config → vcs_versioning._config - Change setuptools_scm.git → vcs_versioning._backends._git - Change setuptools_scm.version.ScmVersion → vcs_versioning.ScmVersion - Change setuptools_scm.version.meta → vcs_versioning._version_schemes.meta - Change setuptools_scm.NonNormalizedVersion → vcs_versioning.NonNormalizedVersion - Update CHANGELOG path from ../CHANGELOG.md → ../setuptools-scm/CHANGELOG.md Documentation now correctly references the vcs-versioning package where the core functionality has been moved. mkdocs build succeeds.
1 parent d17de42 commit 18d78a8

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

docs/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{%
2-
include-markdown "../CHANGELOG.md"
2+
include-markdown "../setuptools-scm/CHANGELOG.md"
33
%}

docs/config.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
8080
The regex needs to contain either a single match group, or a group
8181
named `version`, that captures the actual version information.
8282

83-
Defaults to the value of [setuptools_scm._config.DEFAULT_TAG_REGEX][]
83+
Defaults to the value of [vcs_versioning._config.DEFAULT_TAG_REGEX][]
8484
which supports tags with optional "v" prefix (recommended), project prefixes,
8585
and various version formats.
8686

@@ -127,7 +127,7 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
127127
`scm.git.describe_command`
128128
: This command will be used instead the default `git describe --long` command.
129129

130-
Defaults to the value set by [setuptools_scm.git.DEFAULT_DESCRIBE][]
130+
Defaults to the value set by [vcs_versioning._backends._git.DEFAULT_DESCRIBE][]
131131

132132
`scm.git.pre_parse`
133133
: A string specifying which git pre-parse function to use before parsing version information.
@@ -151,15 +151,15 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
151151
`normalize`
152152
: A boolean flag indicating if the version string should be normalized.
153153
Defaults to `True`. Setting this to `False` is equivalent to setting
154-
`version_cls` to [setuptools_scm.NonNormalizedVersion][]
154+
`version_cls` to [vcs_versioning.NonNormalizedVersion][]
155155

156156
`version_cls: type|str = packaging.version.Version`
157157
: An optional class used to parse, verify and possibly normalize the version
158158
string. Its constructor should receive a single string argument, and its
159159
`str` should return the normalized version string to use.
160160
This option can also receive a class qualified name as a string.
161161

162-
The [setuptools_scm.NonNormalizedVersion][] convenience class is
162+
The [vcs_versioning.NonNormalizedVersion][] convenience class is
163163
provided to disable the normalization step done by
164164
`packaging.version.Version`. If this is used while `setuptools-scm`
165165
is integrated in a setuptools packaging process, the non-normalized
@@ -279,16 +279,16 @@ tar -tzf dist/package-*.tar.gz
279279

280280
### constants
281281

282-
::: setuptools_scm._config.DEFAULT_TAG_REGEX
282+
::: vcs_versioning._config.DEFAULT_TAG_REGEX
283283
options:
284284
heading_level: 4
285285

286-
::: setuptools_scm.git.DEFAULT_DESCRIBE
286+
::: vcs_versioning._backends._git.DEFAULT_DESCRIBE
287287
options:
288288
heading_level: 4
289289

290290

291291
### the configuration class
292-
::: setuptools_scm.Configuration
292+
::: vcs_versioning.Configuration
293293
options:
294294
heading_level: 4

docs/customizing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ setup(use_scm_version={'local_scheme': clean_scheme})
6868

6969
## alternative version classes
7070

71-
::: setuptools_scm.NonNormalizedVersion
71+
::: vcs_versioning.NonNormalizedVersion

docs/extending.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
entrypoint's name. E.g. for the built-in entrypoint for Git the
1515
entrypoint is named `.git` and references `setuptools_scm.git:parse`
1616

17-
The return value MUST be a [`setuptools_scm.version.ScmVersion`][] instance
18-
created by the function [`setuptools_scm.version.meta`][].
17+
The return value MUST be a [`vcs_versioning.ScmVersion`][] instance
18+
created by the function [`vcs_versioning._version_schemes.meta`][].
1919

2020
`setuptools_scm.files_command`
2121
: Either a string containing a shell command that prints all SCM managed
@@ -27,12 +27,12 @@
2727

2828
### api reference for scm version objects
2929

30-
::: setuptools_scm.version.ScmVersion
30+
::: vcs_versioning.ScmVersion
3131
options:
3232
show_root_heading: yes
3333
heading_level: 4
3434

35-
::: setuptools_scm.version.meta
35+
::: vcs_versioning._version_schemes.meta
3636
options:
3737
show_root_heading: yes
3838
heading_level: 4
@@ -45,7 +45,7 @@
4545

4646
### `setuptools_scm.version_scheme`
4747
Configures how the version number is constructed given a
48-
[ScmVersion][setuptools_scm.version.ScmVersion] instance and should return a string
48+
[ScmVersion][vcs_versioning.ScmVersion] instance and should return a string
4949
representing the version.
5050

5151
### Available implementations
@@ -130,7 +130,7 @@ representing the version.
130130

131131
### `setuptools_scm.local_scheme`
132132
Configures how the local part of a version is rendered given a
133-
[ScmVersion][setuptools_scm.version.ScmVersion] instance and should return a string
133+
[ScmVersion][vcs_versioning.ScmVersion] instance and should return a string
134134
representing the local version.
135135
Dates and times are in Coordinated Universal Time (UTC), because as part
136136
of the version, they should be location independent.

0 commit comments

Comments
 (0)