Skip to content

Commit 8507c32

Browse files
dolfinusdolfinus
committed
Improve docs
1 parent 7d79294 commit 8507c32

File tree

5 files changed

+48
-39
lines changed

5 files changed

+48
-39
lines changed

‎README.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,15 @@ version number according
3030
**Features:**
3131

3232
- Can be installed & configured through both ``setup.py`` and :pep:`518`'s ``pyproject.toml``
33+
3334
- Does not require to change source code of the project
35+
3436
- Tag-, file-, and callback-based versioning schemas are supported
37+
3538
- Templates for *tag*, *dev* and *dirty* versions are separated
39+
3640
- Templates support a lot of substitutions including git and environment information
41+
3742
- Well-documented
3843

3944

@@ -43,6 +48,7 @@ between ``setuptools-git-versioning`` and other tools.
4348
**Limitations:**
4449

4550
- Currently the only supported VCS supported is *Git*
51+
4652
- Currently does not support exporting version to file for runtime use
4753

4854
.. documentation
@@ -59,7 +65,7 @@ Contribution Guide
5965

6066
See ./CONTRIBUTING.rst
6167

62-
.. install
68+
.. installation
6369
6470
Install
6571
------------

‎docs/differences.rst

Lines changed: 38 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,8 @@ Configuration
196196
| setuptools-git-version | no | yes | no |
197197
+------------------------------------+----------------+------------+------------+
198198

199-
Substitutions
200-
--------------
199+
:ref:`Substitutions <substitutions>`
200+
------------------------------------
201201
+------------------------------------+---------------+-----------+----------+--------+
202202
| Package | Commits count | Short SHA | Full SHA | Branch |
203203
+====================================+===============+===========+==========+========+
@@ -254,38 +254,40 @@ Substitutions
254254
| setuptools-git-version | no | no | no | no |
255255
+------------------------------------+---------------+------------------+-------------------+--------------+
256256

257-
Tag-based versioning
258-
--------------------
259-
+------------------------------------+------------------------+---------------+-----------------+
260-
| Package | Dev (distance) version | Dirty version | Initial version |
261-
+====================================+========================+===============+=================+
262-
| setuptools-git-versioning | yes | yes | yes |
263-
+------------------------------------+------------------------+---------------+-----------------+
264-
| setuptools-scm | yes | yes | no |
265-
+------------------------------------+------------------------+---------------+-----------------+
266-
| versioneer | yes | no | no |
267-
+------------------------------------+------------------------+---------------+-----------------+
268-
| miniver | no | no | no |
269-
+------------------------------------+------------------------+---------------+-----------------+
270-
| versioningit | yes | yes | yes |
271-
+------------------------------------+------------------------+---------------+-----------------+
272-
| setuptools-git-ver | yes | yes | no |
273-
+------------------------------------+------------------------+---------------+-----------------+
274-
| another-setuptools-git-version | yes | no | yes |
275-
+------------------------------------+------------------------+---------------+-----------------+
276-
| bad-setuptools-git-version | yes | no | yes |
277-
+------------------------------------+------------------------+---------------+-----------------+
278-
| even-better-setuptools-git-version | no | no | yes |
279-
+------------------------------------+------------------------+---------------+-----------------+
280-
| better-setuptools-git-version | no | no | yes |
281-
+------------------------------------+------------------------+---------------+-----------------+
282-
| very-good-setuptools-git-version | no | no | no |
283-
+------------------------------------+------------------------+---------------+-----------------+
284-
| setuptools-git-version | no | no | no |
285-
+------------------------------------+------------------------+---------------+-----------------+
257+
:ref:`Tag-based versioning <tag-based-release>`
258+
-----------------------------------------------
259+
260+
+------------------------------------+-------------------------+---------------+-----------------+
261+
| Package | Post (distance) version | Dirty version | Initial version |
262+
+====================================+=========================+===============+=================+
263+
| setuptools-git-versioning | yes | yes | yes |
264+
+------------------------------------+-------------------------+---------------+-----------------+
265+
| setuptools-scm | yes | yes | no |
266+
+------------------------------------+-------------------------+---------------+-----------------+
267+
| versioneer | yes | no | no |
268+
+------------------------------------+-------------------------+---------------+-----------------+
269+
| miniver | no | no | no |
270+
+------------------------------------+-------------------------+---------------+-----------------+
271+
| versioningit | yes | yes | yes |
272+
+------------------------------------+-------------------------+---------------+-----------------+
273+
| setuptools-git-ver | yes | yes | no |
274+
+------------------------------------+-------------------------+---------------+-----------------+
275+
| another-setuptools-git-version | yes | no | yes |
276+
+------------------------------------+-------------------------+---------------+-----------------+
277+
| bad-setuptools-git-version | yes | no | yes |
278+
+------------------------------------+-------------------------+---------------+-----------------+
279+
| even-better-setuptools-git-version | no | no | yes |
280+
+------------------------------------+-------------------------+---------------+-----------------+
281+
| better-setuptools-git-version | no | no | yes |
282+
+------------------------------------+-------------------------+---------------+-----------------+
283+
| very-good-setuptools-git-version | no | no | no |
284+
+------------------------------------+-------------------------+---------------+-----------------+
285+
| setuptools-git-version | no | no | no |
286+
+------------------------------------+-------------------------+---------------+-----------------+
287+
288+
:ref:`File-based versioning <file-based-release>`
289+
-------------------------------------------------
286290

287-
File-based versioning
288-
---------------------
289291
+------------------------------------+----------------+---------------+-------------------------+
290292
| Package | Read from file | Write to file | Use file commit history |
291293
+====================================+================+===============+=========================+
@@ -314,8 +316,9 @@ File-based versioning
314316
| setuptools-git-version | no | no | no |
315317
+------------------------------------+----------------+---------------+-------------------------+
316318

317-
Callback-based versioning
318-
-------------------------
319+
:ref:`Callback-based versioning <callback-based-release>`
320+
---------------------------------------------------------
321+
319322
+------------------------------------+-------------------------+------------------------+
320323
| Package | Execute module function | Import module variable |
321324
+====================================+=========================+========================+

‎docs/install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
.. _installation:
22
.. include:: ../README.rst
3-
:start-after: install
3+
:start-after: installation

‎docs/schemas/tag/dirty_version.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Version number template
3131

3232
Sometimes you want see just ``1.0.0.post1+dirty`` value or even ``1.0.0+dirty``.
3333

34-
To get version in such a format you set a template in the config file:
34+
To get version in such a format you can set a template in the config file:
3535

3636
- ``setup.py``:
3737

‎docs/schemas/tag/post_release.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Version number template
2929

3030
Sometimes you want see just ``1.0.0.post1`` value or even ``1.0.0``.
3131

32-
To get version in such a format you set a template in the config file:
32+
To get version in such a format you can set a template in the config file:
3333

3434
- ``setup.py``:
3535

0 commit comments

Comments
 (0)