Skip to content

Commit 57958ea

Browse files
committed
Fixed documentation layout
1 parent 5aedd64 commit 57958ea

File tree

6 files changed

+29
-9
lines changed

6 files changed

+29
-9
lines changed

docs/howtos/index.md

-6
This file was deleted.

docs/howtos/nav.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
- *.md

docs/index.md

+26-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,30 @@ title: Bump My Version
55

66
# Bump My Version
77

8+
Bump My Version's purpose is to:
9+
10+
- Work as a part of an automated build system
11+
- Manage project versioning through the project's development life cycle
12+
- Incrementing version numbers
13+
- Serializing version numbers
14+
- Parsing version numbers
15+
- Support SemVer, CalVer, and other versioning schemes
16+
- Modify project files as part of the project's development life cycle
17+
- Work with the project's source control system
18+
- Committing changes
19+
- Tagging releases
20+
- Reading version numbers from tags
21+
22+
## Installation
23+
24+
You can download and install the latest version of this software from the Python package index (PyPI) as follows:
25+
26+
```console
27+
pip install --upgrade bump-my-version
28+
```
29+
<!--
30+
## Jump to section
31+
832
::: grid wide-gap
933
1034
::: card-container
@@ -28,7 +52,7 @@ title: Bump My Version
2852
2953
::: card-content
3054
31-
[Reference](reference/index.md)
55+
[Reference](reference/)
3256
{ .card-content-title }
3357
3458
Consult the reference for specifics about the Bump My Version's configuration and commands.
@@ -58,3 +82,4 @@ title: Bump My Version
5882
{ .card-content-title }
5983
6084
Want to understand the library better? Read our explanations behind the design.
85+
-->

docs/reference/configuration/version-component.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Version part configuration
2+
title: Version component-specific configuration
33
description: Configuration options for a specific version part
44
icon:
55
date: 2024-08-11
File renamed without changes.

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ docs = [
6868
"mkdocs-gen-files",
6969
"mkdocs-git-authors-plugin",
7070
"mkdocs-git-committers-plugin",
71-
"mkdocs-git-revision-date-localized-plugin",
71+
"mkdocs-git-revision-date-localized-plugin>=1.2.6",
7272
"mkdocs-include-markdown-plugin",
7373
"mkdocs-literate-nav",
7474
"mkdocs-material",

0 commit comments

Comments
 (0)