Skip to content

Commit 4f90348

Browse files
coordtcoordt
committed
Updated documentation
1 parent 406f97a commit 4f90348

33 files changed

+1631
-703
lines changed

‎CONTRIBUTING.md

-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ All types of contributions are encouraged and valued. See the [Table of Contents
1919
- [Your First Code Contribution](#your-first-code-contribution)
2020
- [Improving The Documentation](#improving-the-documentation)
2121
- [Styleguides](#styleguides)
22-
- [Commit Messages](#commit-messages)
2322
- [Join The Project Team](#join-the-project-team)
2423

2524

‎Makefile

-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ release-version: get-version do-release ## Release a specific version: release-
2727

2828
docs: ## generate Sphinx HTML documentation, including API docs
2929
mkdir -p docs
30-
rm -rf docsrc/_autosummary
3130
ls -A1 docs | xargs -I {} rm -rf docs/{}
3231
$(MAKE) -C docsrc clean html
3332
cp -a docsrc/_build/html/. docs

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ Example output:
129129
`-h, --help`
130130
Print help and exit
131131

132-
## Using bumpversion in a script
132+
## Using bump-my-version in a script
133133

134-
If you need to use the version generated by bumpversion in a script, you can make use of the `show` subcommand.
134+
If you need to use the version generated by bump-my-version in a script, you can make use of the `show` subcommand.
135135

136136
Say, for example, that you are using git-flow to manage your project and want to automatically create a release. When you issue `git flow release start` you need to know the new version before applying the change.
137137

‎docsrc/LICENSE

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../LICENSE
2+
```

‎docsrc/conf.py

+1-11
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
extensions = [
2323
"myst_parser",
2424
"autodoc2",
25-
# "sphinx.ext.autodoc",
2625
"sphinx.ext.viewcode",
2726
"sphinx.ext.autosummary",
2827
"sphinx.ext.intersphinx",
@@ -42,16 +41,6 @@
4241
autodoc2_output_dir = "reference"
4342
autodoc2_index_template = None
4443

45-
autodoc_default_flags = [
46-
# Make sure that any autodoc declarations show the right members
47-
"members",
48-
"undoc-members",
49-
"private-members",
50-
]
51-
autodoc_class_signature = "separated"
52-
autodoc_member_order = "bysource"
53-
autodoc_typehints = "description"
54-
5544
autosummary_generate = True
5645

5746
napoleon_attr_annotations = True
@@ -72,6 +61,7 @@
7261
"tasklist",
7362
"fieldlist",
7463
]
64+
myst_heading_anchors = 2
7565
intersphinx_mapping = {
7666
"python": ("https://docs.python.org/3", None),
7767
}

‎docsrc/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ tutorials/index
1111
howtos/index
1212
reference/index
1313
explanation/index
14-
contributing
15-
changelog
14+
CONTRIBUTING
15+
CHANGELOG
1616
```
1717

1818
## Indices and tables

‎docsrc/reference/bumpversion/bumpversion.aliases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
### API
2525

26-
`````{py:class} AliasedGroup(name: typing.Optional[str] = None, commands: typing.Optional[typing.Union[typing.Dict[str, click.core.Command], typing.Sequence[click.core.Command]]] = None, **attrs: typing.Any)
26+
`````{py:class} AliasedGroup(*args: typing.Any, **kwargs: typing.Any)
2727
:canonical: bumpversion.aliases.AliasedGroup
2828
2929
Bases: {py:obj}`rich_click.rich_group.RichGroup`

‎docsrc/reference/bumpversion/bumpversion.bump.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
````{py:data} logger
4747
:canonical: bumpversion.bump.logger
4848
:value: >
49-
None
49+
'get_indented_logger(...)'
5050
5151
```{autodoc2-docstring} bumpversion.bump.logger
5252
```

‎docsrc/reference/bumpversion/bumpversion.cli.md

+25-3
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@
3131
- ```{autodoc2-docstring} bumpversion.cli.replace
3232
:summary:
3333
```
34+
* - {py:obj}`sample_config <bumpversion.cli.sample_config>`
35+
- ```{autodoc2-docstring} bumpversion.cli.sample_config
36+
:summary:
37+
```
38+
* - {py:obj}`show_bump <bumpversion.cli.show_bump>`
39+
- ```{autodoc2-docstring} bumpversion.cli.show_bump
40+
:summary:
41+
```
3442
````
3543

3644
### Data
@@ -50,7 +58,7 @@
5058
````{py:data} logger
5159
:canonical: bumpversion.cli.logger
5260
:value: >
53-
None
61+
'get_indented_logger(...)'
5462
5563
```{autodoc2-docstring} bumpversion.cli.logger
5664
```
@@ -64,7 +72,7 @@
6472
```
6573
````
6674

67-
````{py:function} bump(args: list, config_file: typing.Optional[str], verbose: int, allow_dirty: typing.Optional[bool], current_version: typing.Optional[str], new_version: typing.Optional[str], parse: typing.Optional[str], serialize: typing.Optional[typing.List[str]], search: typing.Optional[str], replace: typing.Optional[str], no_regex: bool, no_configured_files: bool, ignore_missing_version: bool, dry_run: bool, commit: typing.Optional[bool], tag: typing.Optional[bool], sign_tags: typing.Optional[bool], tag_name: typing.Optional[str], tag_message: typing.Optional[str], message: typing.Optional[str], commit_args: typing.Optional[str], show_list: bool) -> None
75+
````{py:function} bump(args: list, config_file: typing.Optional[str], verbose: int, allow_dirty: typing.Optional[bool], current_version: typing.Optional[str], new_version: typing.Optional[str], parse: typing.Optional[str], serialize: typing.Optional[typing.List[str]], search: typing.Optional[str], replace: typing.Optional[str], regex: typing.Optional[bool], no_configured_files: bool, ignore_missing_version: bool, dry_run: bool, commit: typing.Optional[bool], tag: typing.Optional[bool], sign_tags: typing.Optional[bool], tag_name: typing.Optional[str], tag_message: typing.Optional[str], message: typing.Optional[str], commit_args: typing.Optional[str], show_list: bool) -> None
6876
:canonical: bumpversion.cli.bump
6977
7078
```{autodoc2-docstring} bumpversion.cli.bump
@@ -78,9 +86,23 @@
7886
```
7987
````
8088

81-
````{py:function} replace(files: list, config_file: typing.Optional[str], verbose: int, allow_dirty: typing.Optional[bool], current_version: typing.Optional[str], new_version: typing.Optional[str], parse: typing.Optional[str], serialize: typing.Optional[typing.List[str]], search: typing.Optional[str], replace: typing.Optional[str], no_regex: bool, no_configured_files: bool, ignore_missing_version: bool, dry_run: bool) -> None
89+
````{py:function} replace(files: list, config_file: typing.Optional[str], verbose: int, allow_dirty: typing.Optional[bool], current_version: typing.Optional[str], new_version: typing.Optional[str], parse: typing.Optional[str], serialize: typing.Optional[typing.List[str]], search: typing.Optional[str], replace: typing.Optional[str], regex: bool, no_configured_files: bool, ignore_missing_version: bool, dry_run: bool) -> None
8290
:canonical: bumpversion.cli.replace
8391
8492
```{autodoc2-docstring} bumpversion.cli.replace
8593
```
8694
````
95+
96+
````{py:function} sample_config(prompt: bool, destination: str) -> None
97+
:canonical: bumpversion.cli.sample_config
98+
99+
```{autodoc2-docstring} bumpversion.cli.sample_config
100+
```
101+
````
102+
103+
````{py:function} show_bump(version: str, config_file: typing.Optional[str], ascii: bool) -> None
104+
:canonical: bumpversion.cli.show_bump
105+
106+
```{autodoc2-docstring} bumpversion.cli.show_bump
107+
```
108+
````

‎docsrc/reference/bumpversion/bumpversion.config.create.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# {py:mod}`bumpversion.config.create`
2+
3+
```{py:module} bumpversion.config.create
4+
```
5+
6+
```{autodoc2-docstring} bumpversion.config.create
7+
:allowtitles:
8+
```
9+
10+
## Module Contents
11+
12+
### Functions
13+
14+
````{list-table}
15+
:class: autosummary longtable
16+
:align: left
17+
18+
* - {py:obj}`create_configuration <bumpversion.config.create.create_configuration>`
19+
- ```{autodoc2-docstring} bumpversion.config.create.create_configuration
20+
:summary:
21+
```
22+
* - {py:obj}`get_defaults_from_dest <bumpversion.config.create.get_defaults_from_dest>`
23+
- ```{autodoc2-docstring} bumpversion.config.create.get_defaults_from_dest
24+
:summary:
25+
```
26+
````
27+
28+
### API
29+
30+
````{py:function} create_configuration(destination: str, prompt: bool) -> tomlkit.TOMLDocument
31+
:canonical: bumpversion.config.create.create_configuration
32+
33+
```{autodoc2-docstring} bumpversion.config.create.create_configuration
34+
```
35+
````
36+
37+
````{py:function} get_defaults_from_dest(destination: str) -> typing.Tuple[dict, tomlkit.TOMLDocument]
38+
:canonical: bumpversion.config.create.get_defaults_from_dest
39+
40+
```{autodoc2-docstring} bumpversion.config.create.get_defaults_from_dest
41+
```
42+
````

‎docsrc/reference/bumpversion/bumpversion.config.files.md

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# {py:mod}`bumpversion.config.files`
2+
3+
```{py:module} bumpversion.config.files
4+
```
5+
6+
```{autodoc2-docstring} bumpversion.config.files
7+
:allowtitles:
8+
```
9+
10+
## Module Contents
11+
12+
### Functions
13+
14+
````{list-table}
15+
:class: autosummary longtable
16+
:align: left
17+
18+
* - {py:obj}`find_config_file <bumpversion.config.files.find_config_file>`
19+
- ```{autodoc2-docstring} bumpversion.config.files.find_config_file
20+
:summary:
21+
```
22+
* - {py:obj}`read_config_file <bumpversion.config.files.read_config_file>`
23+
- ```{autodoc2-docstring} bumpversion.config.files.read_config_file
24+
:summary:
25+
```
26+
* - {py:obj}`read_toml_file <bumpversion.config.files.read_toml_file>`
27+
- ```{autodoc2-docstring} bumpversion.config.files.read_toml_file
28+
:summary:
29+
```
30+
* - {py:obj}`update_config_file <bumpversion.config.files.update_config_file>`
31+
- ```{autodoc2-docstring} bumpversion.config.files.update_config_file
32+
:summary:
33+
```
34+
````
35+
36+
### Data
37+
38+
````{list-table}
39+
:class: autosummary longtable
40+
:align: left
41+
42+
* - {py:obj}`logger <bumpversion.config.files.logger>`
43+
- ```{autodoc2-docstring} bumpversion.config.files.logger
44+
:summary:
45+
```
46+
* - {py:obj}`CONFIG_FILE_SEARCH_ORDER <bumpversion.config.files.CONFIG_FILE_SEARCH_ORDER>`
47+
- ```{autodoc2-docstring} bumpversion.config.files.CONFIG_FILE_SEARCH_ORDER
48+
:summary:
49+
```
50+
````
51+
52+
### API
53+
54+
````{py:data} logger
55+
:canonical: bumpversion.config.files.logger
56+
:value: >
57+
'get_indented_logger(...)'
58+
59+
```{autodoc2-docstring} bumpversion.config.files.logger
60+
```
61+
62+
````
63+
64+
````{py:data} CONFIG_FILE_SEARCH_ORDER
65+
:canonical: bumpversion.config.files.CONFIG_FILE_SEARCH_ORDER
66+
:value: >
67+
('.bumpversion.cfg', '.bumpversion.toml', 'setup.cfg', 'pyproject.toml')
68+
69+
```{autodoc2-docstring} bumpversion.config.files.CONFIG_FILE_SEARCH_ORDER
70+
```
71+
72+
````
73+
74+
````{py:function} find_config_file(explicit_file: typing.Union[str, pathlib.Path, None] = None) -> typing.Union[pathlib.Path, None]
75+
:canonical: bumpversion.config.files.find_config_file
76+
77+
```{autodoc2-docstring} bumpversion.config.files.find_config_file
78+
```
79+
````
80+
81+
````{py:function} read_config_file(config_file: typing.Union[str, pathlib.Path, None] = None) -> typing.Dict[str, typing.Any]
82+
:canonical: bumpversion.config.files.read_config_file
83+
84+
```{autodoc2-docstring} bumpversion.config.files.read_config_file
85+
```
86+
````
87+
88+
````{py:function} read_toml_file(file_path: pathlib.Path) -> typing.Dict[str, typing.Any]
89+
:canonical: bumpversion.config.files.read_toml_file
90+
91+
```{autodoc2-docstring} bumpversion.config.files.read_toml_file
92+
```
93+
````
94+
95+
````{py:function} update_config_file(config_file: typing.Union[str, pathlib.Path], config: bumpversion.config.models.Config, current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: typing.MutableMapping, dry_run: bool = False) -> None
96+
:canonical: bumpversion.config.files.update_config_file
97+
98+
```{autodoc2-docstring} bumpversion.config.files.update_config_file
99+
```
100+
````

‎docsrc/reference/bumpversion/bumpversion.config.files_legacy.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# {py:mod}`bumpversion.config.files_legacy`
2+
3+
```{py:module} bumpversion.config.files_legacy
4+
```
5+
6+
```{autodoc2-docstring} bumpversion.config.files_legacy
7+
:allowtitles:
8+
```
9+
10+
## Module Contents
11+
12+
### Functions
13+
14+
````{list-table}
15+
:class: autosummary longtable
16+
:align: left
17+
18+
* - {py:obj}`read_ini_file <bumpversion.config.files_legacy.read_ini_file>`
19+
- ```{autodoc2-docstring} bumpversion.config.files_legacy.read_ini_file
20+
:summary:
21+
```
22+
* - {py:obj}`update_ini_config_file <bumpversion.config.files_legacy.update_ini_config_file>`
23+
- ```{autodoc2-docstring} bumpversion.config.files_legacy.update_ini_config_file
24+
:summary:
25+
```
26+
````
27+
28+
### Data
29+
30+
````{list-table}
31+
:class: autosummary longtable
32+
:align: left
33+
34+
* - {py:obj}`logger <bumpversion.config.files_legacy.logger>`
35+
- ```{autodoc2-docstring} bumpversion.config.files_legacy.logger
36+
:summary:
37+
```
38+
````
39+
40+
### API
41+
42+
````{py:data} logger
43+
:canonical: bumpversion.config.files_legacy.logger
44+
:value: >
45+
'get_indented_logger(...)'
46+
47+
```{autodoc2-docstring} bumpversion.config.files_legacy.logger
48+
```
49+
50+
````
51+
52+
````{py:function} read_ini_file(file_path: pathlib.Path) -> typing.Dict[str, typing.Any]
53+
:canonical: bumpversion.config.files_legacy.read_ini_file
54+
55+
```{autodoc2-docstring} bumpversion.config.files_legacy.read_ini_file
56+
```
57+
````
58+
59+
````{py:function} update_ini_config_file(config_file: typing.Union[str, pathlib.Path], current_version: str, new_version: str, dry_run: bool = False) -> None
60+
:canonical: bumpversion.config.files_legacy.update_ini_config_file
61+
62+
```{autodoc2-docstring} bumpversion.config.files_legacy.update_ini_config_file
63+
```
64+
````

0 commit comments

Comments
 (0)