Added and re-organized documentation

bumpversion/cli.py

@@ -330,7 +330,7 @@ def show(args: List[str], config_file: Optional[str], format_: str, increment: O
     metavar="VERSION",
     required=False,
     envvar="BUMPVERSION_NEW_VERSION",
-    help="New version that should be in the files",
+    help="New version that should be in the files. If not specified, it will be None.",
 )
 @click.option(
     "--parse",

docsrc/conf.py

@@ -21,7 +21,8 @@
 
 extensions = [
     "myst_parser",
-    "sphinx.ext.autodoc",
+    "autodoc2",
+    # "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
@@ -36,6 +37,11 @@
 autosectionlabel_prefix_document = True
 autosectionlabel_maxdepth = 2
 
+autodoc2_packages = ["../bumpversion"]
+autodoc2_render_plugin = "myst"
+autodoc2_output_dir = "reference"
+autodoc2_index_template = None
+
 autodoc_default_flags = [
     # Make sure that any autodoc declarations show the right members
     "members",

docsrc/explanation/index.md

@@ -0,0 +1,4 @@
+# Explanation
+
+```{toctree}
+```

docsrc/howtos/index.md

@@ -0,0 +1,6 @@
+# How-To Guides
+
+
+
+```{toctree}
+```

docsrc/index.md

@@ -1,4 +1,4 @@
-# Bump My Version's documentation
+# Bump My Version
 
 ```{toctree}
 ---
@@ -7,12 +7,10 @@ caption: Contents
 ---
 Introduction <readme>
 usage
-configuration
-version-parts
-formatting-context
-search-and-replace
-cli
-api
+tutorials/index
+howtos/index
+reference/index
+explanation/index
 contributing
 changelog
 ```

docsrc/reference/bumpversion/bumpversion.__main__.md

@@ -0,0 +1,8 @@
+# {py:mod}`bumpversion.__main__`
+
+```{py:module} bumpversion.__main__
+```
+
+```{autodoc2-docstring} bumpversion.__main__
+:allowtitles:
+```

docsrc/reference/bumpversion/bumpversion.aliases.md

@@ -0,0 +1,56 @@
+# {py:mod}`bumpversion.aliases`
+
+```{py:module} bumpversion.aliases
+```
+
+```{autodoc2-docstring} bumpversion.aliases
+:allowtitles:
+```
+
+## Module Contents
+
+### Classes
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`AliasedGroup <bumpversion.aliases.AliasedGroup>`
+  - ```{autodoc2-docstring} bumpversion.aliases.AliasedGroup
+    :summary:
+    ```
+````
+
+### API
+
+`````{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)
+:canonical: bumpversion.aliases.AliasedGroup
+
+Bases: {py:obj}`rich_click.rich_group.RichGroup`
+
+```{autodoc2-docstring} bumpversion.aliases.AliasedGroup
+```
+
+```{rubric} Initialization
+```
+
+```{autodoc2-docstring} bumpversion.aliases.AliasedGroup.__init__
+```
+
+````{py:method} get_command(ctx: click.Context, cmd_name: str) -> typing.Optional[rich_click.Command]
+:canonical: bumpversion.aliases.AliasedGroup.get_command
+
+```{autodoc2-docstring} bumpversion.aliases.AliasedGroup.get_command
+```
+
+````
+
+````{py:method} resolve_command(ctx: click.Context, args: typing.List[str]) -> tuple
+:canonical: bumpversion.aliases.AliasedGroup.resolve_command
+
+```{autodoc2-docstring} bumpversion.aliases.AliasedGroup.resolve_command
+```
+
+````
+
+`````

docsrc/reference/bumpversion/bumpversion.autocast.md

@@ -0,0 +1,64 @@
+# {py:mod}`bumpversion.autocast`
+
+```{py:module} bumpversion.autocast
+```
+
+```{autodoc2-docstring} bumpversion.autocast
+:allowtitles:
+```
+
+## Module Contents
+
+### Functions
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`boolify <bumpversion.autocast.boolify>`
+  - ```{autodoc2-docstring} bumpversion.autocast.boolify
+    :summary:
+    ```
+* - {py:obj}`noneify <bumpversion.autocast.noneify>`
+  - ```{autodoc2-docstring} bumpversion.autocast.noneify
+    :summary:
+    ```
+* - {py:obj}`listify <bumpversion.autocast.listify>`
+  - ```{autodoc2-docstring} bumpversion.autocast.listify
+    :summary:
+    ```
+* - {py:obj}`autocast_value <bumpversion.autocast.autocast_value>`
+  - ```{autodoc2-docstring} bumpversion.autocast.autocast_value
+    :summary:
+    ```
+````
+
+### API
+
+````{py:function} boolify(s: str) -> bool
+:canonical: bumpversion.autocast.boolify
+
+```{autodoc2-docstring} bumpversion.autocast.boolify
+```
+````
+
+````{py:function} noneify(s: str) -> None
+:canonical: bumpversion.autocast.noneify
+
+```{autodoc2-docstring} bumpversion.autocast.noneify
+```
+````
+
+````{py:function} listify(s: str) -> list
+:canonical: bumpversion.autocast.listify
+
+```{autodoc2-docstring} bumpversion.autocast.listify
+```
+````
+
+````{py:function} autocast_value(var: typing.Any) -> typing.Any
+:canonical: bumpversion.autocast.autocast_value
+
+```{autodoc2-docstring} bumpversion.autocast.autocast_value
+```
+````

docsrc/reference/bumpversion/bumpversion.bump.md

@@ -0,0 +1,75 @@
+# {py:mod}`bumpversion.bump`
+
+```{py:module} bumpversion.bump
+```
+
+```{autodoc2-docstring} bumpversion.bump
+:allowtitles:
+```
+
+## Module Contents
+
+### Functions
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`get_next_version <bumpversion.bump.get_next_version>`
+  - ```{autodoc2-docstring} bumpversion.bump.get_next_version
+    :summary:
+    ```
+* - {py:obj}`do_bump <bumpversion.bump.do_bump>`
+  - ```{autodoc2-docstring} bumpversion.bump.do_bump
+    :summary:
+    ```
+* - {py:obj}`commit_and_tag <bumpversion.bump.commit_and_tag>`
+  - ```{autodoc2-docstring} bumpversion.bump.commit_and_tag
+    :summary:
+    ```
+````
+
+### Data
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`logger <bumpversion.bump.logger>`
+  - ```{autodoc2-docstring} bumpversion.bump.logger
+    :summary:
+    ```
+````
+
+### API
+
+````{py:data} logger
+:canonical: bumpversion.bump.logger
+:value: >
+   None
+
+```{autodoc2-docstring} bumpversion.bump.logger
+```
+
+````
+
+````{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
+:canonical: bumpversion.bump.get_next_version
+
+```{autodoc2-docstring} bumpversion.bump.get_next_version
+```
+````
+
+````{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
+:canonical: bumpversion.bump.do_bump
+
+```{autodoc2-docstring} bumpversion.bump.do_bump
+```
+````
+
+````{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
+:canonical: bumpversion.bump.commit_and_tag
+
+```{autodoc2-docstring} bumpversion.bump.commit_and_tag
+```
+````

docsrc/reference/bumpversion/bumpversion.cli.md

@@ -0,0 +1,86 @@
+# {py:mod}`bumpversion.cli`
+
+```{py:module} bumpversion.cli
+```
+
+```{autodoc2-docstring} bumpversion.cli
+:allowtitles:
+```
+
+## Module Contents
+
+### Functions
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`cli <bumpversion.cli.cli>`
+  - ```{autodoc2-docstring} bumpversion.cli.cli
+    :summary:
+    ```
+* - {py:obj}`bump <bumpversion.cli.bump>`
+  - ```{autodoc2-docstring} bumpversion.cli.bump
+    :summary:
+    ```
+* - {py:obj}`show <bumpversion.cli.show>`
+  - ```{autodoc2-docstring} bumpversion.cli.show
+    :summary:
+    ```
+* - {py:obj}`replace <bumpversion.cli.replace>`
+  - ```{autodoc2-docstring} bumpversion.cli.replace
+    :summary:
+    ```
+````
+
+### Data
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`logger <bumpversion.cli.logger>`
+  - ```{autodoc2-docstring} bumpversion.cli.logger
+    :summary:
+    ```
+````
+
+### API
+
+````{py:data} logger
+:canonical: bumpversion.cli.logger
+:value: >
+   None
+
+```{autodoc2-docstring} bumpversion.cli.logger
+```
+
+````
+
+````{py:function} cli(ctx: click.core.Context) -> None
+:canonical: bumpversion.cli.cli
+
+```{autodoc2-docstring} bumpversion.cli.cli
+```
+````
+
+````{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
+:canonical: bumpversion.cli.bump
+
+```{autodoc2-docstring} bumpversion.cli.bump
+```
+````
+
+````{py:function} show(args: typing.List[str], config_file: typing.Optional[str], format_: str, increment: typing.Optional[str]) -> None
+:canonical: bumpversion.cli.show
+
+```{autodoc2-docstring} bumpversion.cli.show
+```
+````
+
+````{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
+:canonical: bumpversion.cli.replace
+
+```{autodoc2-docstring} bumpversion.cli.replace
+```
+````