Skip to content

Commit c62d65e

Browse files
coordtcoordt
committed
Added and re-organized documentation
1 parent 8722a0f commit c62d65e

32 files changed

+2635
-53
lines changed

‎bumpversion/cli.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ def show(args: List[str], config_file: Optional[str], format_: str, increment: O
330330
metavar="VERSION",
331331
required=False,
332332
envvar="BUMPVERSION_NEW_VERSION",
333-
help="New version that should be in the files",
333+
help="New version that should be in the files. If not specified, it will be None.",
334334
)
335335
@click.option(
336336
"--parse",

‎docsrc/api.rst

-9
This file was deleted.

‎docsrc/conf.py

+7-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121

2222
extensions = [
2323
"myst_parser",
24-
"sphinx.ext.autodoc",
24+
"autodoc2",
25+
# "sphinx.ext.autodoc",
2526
"sphinx.ext.viewcode",
2627
"sphinx.ext.autosummary",
2728
"sphinx.ext.intersphinx",
@@ -36,6 +37,11 @@
3637
autosectionlabel_prefix_document = True
3738
autosectionlabel_maxdepth = 2
3839

40+
autodoc2_packages = ["../bumpversion"]
41+
autodoc2_render_plugin = "myst"
42+
autodoc2_output_dir = "reference"
43+
autodoc2_index_template = None
44+
3945
autodoc_default_flags = [
4046
# Make sure that any autodoc declarations show the right members
4147
"members",

‎docsrc/explanation/index.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Explanation
2+
3+
```{toctree}
4+
```

‎docsrc/howtos/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# How-To Guides
2+
3+
4+
5+
```{toctree}
6+
```

‎docsrc/index.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Bump My Version's documentation
1+
# Bump My Version
22

33
```{toctree}
44
---
@@ -7,12 +7,10 @@ caption: Contents
77
---
88
Introduction <readme>
99
usage
10-
configuration
11-
version-parts
12-
formatting-context
13-
search-and-replace
14-
cli
15-
api
10+
tutorials/index
11+
howtos/index
12+
reference/index
13+
explanation/index
1614
contributing
1715
changelog
1816
```

‎docsrc/reference/bumpversion/bumpversion.__main__.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# {py:mod}`bumpversion.__main__`
2+
3+
```{py:module} bumpversion.__main__
4+
```
5+
6+
```{autodoc2-docstring} bumpversion.__main__
7+
:allowtitles:
8+
```

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

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# {py:mod}`bumpversion.aliases`
2+
3+
```{py:module} bumpversion.aliases
4+
```
5+
6+
```{autodoc2-docstring} bumpversion.aliases
7+
:allowtitles:
8+
```
9+
10+
## Module Contents
11+
12+
### Classes
13+
14+
````{list-table}
15+
:class: autosummary longtable
16+
:align: left
17+
18+
* - {py:obj}`AliasedGroup <bumpversion.aliases.AliasedGroup>`
19+
- ```{autodoc2-docstring} bumpversion.aliases.AliasedGroup
20+
:summary:
21+
```
22+
````
23+
24+
### API
25+
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)
27+
:canonical: bumpversion.aliases.AliasedGroup
28+
29+
Bases: {py:obj}`rich_click.rich_group.RichGroup`
30+
31+
```{autodoc2-docstring} bumpversion.aliases.AliasedGroup
32+
```
33+
34+
```{rubric} Initialization
35+
```
36+
37+
```{autodoc2-docstring} bumpversion.aliases.AliasedGroup.__init__
38+
```
39+
40+
````{py:method} get_command(ctx: click.Context, cmd_name: str) -> typing.Optional[rich_click.Command]
41+
:canonical: bumpversion.aliases.AliasedGroup.get_command
42+
43+
```{autodoc2-docstring} bumpversion.aliases.AliasedGroup.get_command
44+
```
45+
46+
````
47+
48+
````{py:method} resolve_command(ctx: click.Context, args: typing.List[str]) -> tuple
49+
:canonical: bumpversion.aliases.AliasedGroup.resolve_command
50+
51+
```{autodoc2-docstring} bumpversion.aliases.AliasedGroup.resolve_command
52+
```
53+
54+
````
55+
56+
`````

‎docsrc/reference/bumpversion/bumpversion.autocast.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# {py:mod}`bumpversion.autocast`
2+
3+
```{py:module} bumpversion.autocast
4+
```
5+
6+
```{autodoc2-docstring} bumpversion.autocast
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}`boolify <bumpversion.autocast.boolify>`
19+
- ```{autodoc2-docstring} bumpversion.autocast.boolify
20+
:summary:
21+
```
22+
* - {py:obj}`noneify <bumpversion.autocast.noneify>`
23+
- ```{autodoc2-docstring} bumpversion.autocast.noneify
24+
:summary:
25+
```
26+
* - {py:obj}`listify <bumpversion.autocast.listify>`
27+
- ```{autodoc2-docstring} bumpversion.autocast.listify
28+
:summary:
29+
```
30+
* - {py:obj}`autocast_value <bumpversion.autocast.autocast_value>`
31+
- ```{autodoc2-docstring} bumpversion.autocast.autocast_value
32+
:summary:
33+
```
34+
````
35+
36+
### API
37+
38+
````{py:function} boolify(s: str) -> bool
39+
:canonical: bumpversion.autocast.boolify
40+
41+
```{autodoc2-docstring} bumpversion.autocast.boolify
42+
```
43+
````
44+
45+
````{py:function} noneify(s: str) -> None
46+
:canonical: bumpversion.autocast.noneify
47+
48+
```{autodoc2-docstring} bumpversion.autocast.noneify
49+
```
50+
````
51+
52+
````{py:function} listify(s: str) -> list
53+
:canonical: bumpversion.autocast.listify
54+
55+
```{autodoc2-docstring} bumpversion.autocast.listify
56+
```
57+
````
58+
59+
````{py:function} autocast_value(var: typing.Any) -> typing.Any
60+
:canonical: bumpversion.autocast.autocast_value
61+
62+
```{autodoc2-docstring} bumpversion.autocast.autocast_value
63+
```
64+
````

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

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# {py:mod}`bumpversion.bump`
2+
3+
```{py:module} bumpversion.bump
4+
```
5+
6+
```{autodoc2-docstring} bumpversion.bump
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}`get_next_version <bumpversion.bump.get_next_version>`
19+
- ```{autodoc2-docstring} bumpversion.bump.get_next_version
20+
:summary:
21+
```
22+
* - {py:obj}`do_bump <bumpversion.bump.do_bump>`
23+
- ```{autodoc2-docstring} bumpversion.bump.do_bump
24+
:summary:
25+
```
26+
* - {py:obj}`commit_and_tag <bumpversion.bump.commit_and_tag>`
27+
- ```{autodoc2-docstring} bumpversion.bump.commit_and_tag
28+
:summary:
29+
```
30+
````
31+
32+
### Data
33+
34+
````{list-table}
35+
:class: autosummary longtable
36+
:align: left
37+
38+
* - {py:obj}`logger <bumpversion.bump.logger>`
39+
- ```{autodoc2-docstring} bumpversion.bump.logger
40+
:summary:
41+
```
42+
````
43+
44+
### API
45+
46+
````{py:data} logger
47+
:canonical: bumpversion.bump.logger
48+
:value: >
49+
None
50+
51+
```{autodoc2-docstring} bumpversion.bump.logger
52+
```
53+
54+
````
55+
56+
````{py:function} get_next_version(current_version: bumpversion.version_part.Version, config: bumpversion.config.Config, version_part: typing.Optional[str], new_version: typing.Optional[str]) -> bumpversion.version_part.Version
57+
:canonical: bumpversion.bump.get_next_version
58+
59+
```{autodoc2-docstring} bumpversion.bump.get_next_version
60+
```
61+
````
62+
63+
````{py:function} do_bump(version_part: typing.Optional[str], new_version: typing.Optional[str], config: bumpversion.config.Config, config_file: typing.Optional[pathlib.Path] = None, dry_run: bool = False) -> None
64+
:canonical: bumpversion.bump.do_bump
65+
66+
```{autodoc2-docstring} bumpversion.bump.do_bump
67+
```
68+
````
69+
70+
````{py:function} commit_and_tag(config: bumpversion.config.Config, config_file: typing.Optional[pathlib.Path], configured_files: typing.List[bumpversion.files.ConfiguredFile], ctx: typing.ChainMap, dry_run: bool = False) -> None
71+
:canonical: bumpversion.bump.commit_and_tag
72+
73+
```{autodoc2-docstring} bumpversion.bump.commit_and_tag
74+
```
75+
````

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

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# {py:mod}`bumpversion.cli`
2+
3+
```{py:module} bumpversion.cli
4+
```
5+
6+
```{autodoc2-docstring} bumpversion.cli
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}`cli <bumpversion.cli.cli>`
19+
- ```{autodoc2-docstring} bumpversion.cli.cli
20+
:summary:
21+
```
22+
* - {py:obj}`bump <bumpversion.cli.bump>`
23+
- ```{autodoc2-docstring} bumpversion.cli.bump
24+
:summary:
25+
```
26+
* - {py:obj}`show <bumpversion.cli.show>`
27+
- ```{autodoc2-docstring} bumpversion.cli.show
28+
:summary:
29+
```
30+
* - {py:obj}`replace <bumpversion.cli.replace>`
31+
- ```{autodoc2-docstring} bumpversion.cli.replace
32+
:summary:
33+
```
34+
````
35+
36+
### Data
37+
38+
````{list-table}
39+
:class: autosummary longtable
40+
:align: left
41+
42+
* - {py:obj}`logger <bumpversion.cli.logger>`
43+
- ```{autodoc2-docstring} bumpversion.cli.logger
44+
:summary:
45+
```
46+
````
47+
48+
### API
49+
50+
````{py:data} logger
51+
:canonical: bumpversion.cli.logger
52+
:value: >
53+
None
54+
55+
```{autodoc2-docstring} bumpversion.cli.logger
56+
```
57+
58+
````
59+
60+
````{py:function} cli(ctx: click.core.Context) -> None
61+
:canonical: bumpversion.cli.cli
62+
63+
```{autodoc2-docstring} bumpversion.cli.cli
64+
```
65+
````
66+
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_configured_files: 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
68+
:canonical: bumpversion.cli.bump
69+
70+
```{autodoc2-docstring} bumpversion.cli.bump
71+
```
72+
````
73+
74+
````{py:function} show(args: typing.List[str], config_file: typing.Optional[str], format_: str, increment: typing.Optional[str]) -> None
75+
:canonical: bumpversion.cli.show
76+
77+
```{autodoc2-docstring} bumpversion.cli.show
78+
```
79+
````
80+
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_configured_files: bool, dry_run: bool) -> None
82+
:canonical: bumpversion.cli.replace
83+
84+
```{autodoc2-docstring} bumpversion.cli.replace
85+
```
86+
````

0 commit comments

Comments
 (0)