diff --git a/Makefile b/Makefile index 15eba793..90f1977b 100644 --- a/Makefile +++ b/Makefile @@ -1,29 +1,9 @@ -.PHONY: release-dev release-patch release-minor release-major help docs pubdocs do-release +.PHONY: help docs pubdocs update-requires .DEFAULT_GOAL := help -RELEASE_KIND := patch -BRANCH_NAME := $(shell echo $$(git rev-parse --abbrev-ref HEAD)) -SHORT_BRANCH_NAME := $(shell echo $(BRANCH_NAME) | cut -c 1-20) -PRIMARY_BRANCH_NAME := master -BUMPVERSION_OPTS := -EDIT_CHANGELOG := $(shell if [[ -n $$EDITOR ]] ; then echo "$$EDITOR CHANGELOG.md" ; else echo "true" ; fi) - help: @grep '^[a-zA-Z]' $(MAKEFILE_LIST) | sort | awk -F ':.*?## ' 'NF==2 {printf "\033[36m %-25s\033[0m %s\n", $$1, $$2}' -release-dev: RELEASE_KIND := dev -release-dev: do-release ## Release a new development version: 1.1.1 -> 1.1.1+branchname-1 - -release-patch: RELEASE_KIND := patch -release-patch: do-release ## Release a new patch version: 1.1.1 -> 1.1.2 - -release-minor: RELEASE_KIND := minor -release-minor: do-release ## Release a new minor version: 1.1.1 -> 1.2.0 - -release-major: RELEASE_KIND := major -release-major: do-release ## Release a new major version: 1.1.1 -> 2.0.0 - -release-version: get-version do-release ## Release a specific version: release-version 1.2.3 docs: ## generate Sphinx HTML documentation, including API docs mkdir -p docs @@ -40,33 +20,3 @@ update-requires: ## Update the requirements.txt file pip-compile --extra=test --output-file=requirements/test.txt pyproject.toml pip-compile --extra=docs --output-file=requirements/docs.txt pyproject.toml pip-compile --extra=dev --extra=docs --extra=test --output-file=requirements/dev.txt pyproject.toml - -# -# Helper targets. Not meant to use directly -# - -do-release: - @if [[ "$(BRANCH_NAME)" == "$(PRIMARY_BRANCH_NAME)" ]]; then \ - if [[ "$(RELEASE_KIND)" == "dev" ]]; then \ - echo "Error! Can't bump $(RELEASE_KIND) while on the $(PRIMARY_BRANCH_NAME) branch."; \ - exit; \ - fi; \ - elif [[ "$(RELEASE_KIND)" != "dev" ]]; then \ - echo "Error! Must be on the $(PRIMARY_BRANCH_NAME) branch to bump $(RELEASE_KIND)."; \ - exit; \ - fi; \ - git fetch -p --all; \ - generate-changelog; \ - $(call EDIT_CHANGELOG); \ - ./tools/gen-codeowners.sh $(SOURCE_DIR); \ - git add CODEOWNERS; \ - export BRANCH_NAME=$(SHORT_BRANCH_NAME);bumpversion $(BUMPVERSION_OPTS) $(RELEASE_KIND) --allow-dirty; \ - git push origin $(BRANCH_NAME); \ - git push --tags; - -get-version: # Sets the value after release-version to the VERSION - $(eval VERSION := $(filter-out release-version,$(MAKECMDGOALS))) - $(eval BUMPVERSION_OPTS := --new-version=$(VERSION)) - -%: # NO-OP for unrecognized rules - @: diff --git a/README.md b/README.md index aa6b2ae0..0cf481ae 100644 --- a/README.md +++ b/README.md @@ -18,23 +18,24 @@ ## Overview -Version-bump your software with a single command! +Bump My Version's purpose is to: -A small command line tool to simplify releasing software by updating all version strings in your source code by the correct increment and optionally commit and tag the changes. +- Work as a part of an automated build system +- Manage project versioning through the project's development life cycle + - Incrementing version numbers + - serializing version numbers + - parsing version numbers +- Modify project files as part of the project's development life cycle +- Work with the project's source control system + - Committing changes + - Tagging releases + - Reading version numbers from tags -* version formats are highly configurable -* works without any source code manager, but happily reads tag information from and writes - commits and tags to Git and Mercurial if available -* just handles text files, so it's not specific to any programming language -* supports Python 3.8+ and PyPy3. ## Future Direction -- Make it easier to get the current version - Switch having both the version part and files to change as arguments on the command line. -- Make the version part argument _truly_ optional when `--new-version` is specified - Allow for multiple tags, including one that moves for having a `v2` that always points to the latest version of version 2. [For example](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#recommendations) -- Better UI with [Rich](https://rich.readthedocs.io/en/stable/index.html) ## Installation diff --git a/docsrc/_static/css/custom.css b/docsrc/_static/css/custom.css index cb3ea675..0f5f134a 100644 --- a/docsrc/_static/css/custom.css +++ b/docsrc/_static/css/custom.css @@ -35,3 +35,8 @@ dl.field-list > dd { margin-left: 0; margin-bottom: 0; } + +figure { + padding-bottom: .75rem; + padding-top: .5rem; +} diff --git a/docsrc/_templates/autosummary/base.rst b/docsrc/_templates/autosummary/base.rst deleted file mode 100644 index 3a6f25cb..00000000 --- a/docsrc/_templates/autosummary/base.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. rst-class:: subheading - -{{ fullname }} - -{{ objname | escape | underline}} - -.. currentmodule:: {{ module }} - -.. auto{{ objtype }}:: {{ objname }} diff --git a/docsrc/_templates/autosummary/class.rst b/docsrc/_templates/autosummary/class.rst deleted file mode 100644 index f01446b9..00000000 --- a/docsrc/_templates/autosummary/class.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. rst-class:: subheading - -{{ fullname }} - -{{ objname | escape | underline}} - -.. currentmodule:: {{ module }} - -.. autoclass:: {{ objname }} - :members: - :undoc-members: diff --git a/docsrc/_templates/autosummary/module.rst b/docsrc/_templates/autosummary/module.rst deleted file mode 100644 index db11e376..00000000 --- a/docsrc/_templates/autosummary/module.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. rst-class:: subheading - -{{ fullname }} - -{{ name | escape | underline}} - -.. currentmodule:: {{ fullname }} - -.. automodule:: {{ fullname }} - {% block attributes %} - {% if attributes %} - .. rubric:: Attributes - - .. autosummary:: - :nosignatures: - {% for item in attributes %} - {{ item }} - {%- endfor %} - {% endif %} - {% endblock %} - - {% block functions %} - {% if functions %} - .. rubric:: Functions - - .. autosummary:: - :nosignatures: - :toctree: {{ name }} - {% for item in functions %} - {{ item }} - {%- endfor %} - {% endif %} - {% endblock %} - - {% block classes %} - {% if classes %} - .. rubric:: Classes - - .. autosummary:: - :nosignatures: - :toctree: {{ name }} - {% for item in classes %} - {{ item }} - {%- endfor %} - {% endif %} - {% endblock %} - - {% block exceptions %} - {% if exceptions %} - .. rubric:: Exceptions - - .. autosummary:: - :nosignatures: - :toctree: {{ name }} - {% for item in exceptions %} - {{ item }} - {%- endfor %} - {% endif %} - {% endblock %} - {% block modules -%} - {% if modules %} - - .. rubric:: Modules - - .. autosummary:: - :toctree: {{ name }} - :recursive: - {% for item in modules %} - {{ item }} - {%- endfor %} - {% endif %} - {% endblock %} diff --git a/docsrc/conf.py b/docsrc/conf.py index b60d6e95..abd4eb87 100644 --- a/docsrc/conf.py +++ b/docsrc/conf.py @@ -23,7 +23,6 @@ "myst_parser", "autodoc2", "sphinx.ext.viewcode", - "sphinx.ext.autosummary", "sphinx.ext.intersphinx", "sphinx.ext.autosectionlabel", "sphinx.ext.napoleon", @@ -40,8 +39,10 @@ autodoc2_render_plugin = "myst" autodoc2_output_dir = "reference" autodoc2_index_template = None - -autosummary_generate = True +autodoc2_docstring_parser_regexes = [ + # this will render all docstrings as Markdown + (r".*", "myst"), +] napoleon_attr_annotations = True napoleon_include_special_with_doc = True diff --git a/docsrc/explanation/index.md b/docsrc/explanation/index.md index b1c54c3a..93fbc8ac 100644 --- a/docsrc/explanation/index.md +++ b/docsrc/explanation/index.md @@ -1,4 +1,8 @@ # Explanation ```{toctree} +--- +titlesonly: true +--- +mental-model ``` diff --git a/docsrc/explanation/mental-model.md b/docsrc/explanation/mental-model.md new file mode 100644 index 00000000..90be55cf --- /dev/null +++ b/docsrc/explanation/mental-model.md @@ -0,0 +1,101 @@ +# The mental model used by bump-my-version + +## Overview + +There are four main concepts in bump-my-version: + +1. Configuration +2. Version handling +3. File changing +4. Source control management interface + +## Configuration + +The predecessor to bump-my-version, [bumpversion](https://github.com/peritus/bumpversion), was designed to have the configuration file optional. All configuration values could be specified on the command line. This only worked in the simplest of version schemes. + +bump-my-version is designed to have a configuration file. The configuration file is required to specify the version scheme. The configuration file is also used to specify the files to change and how to change them. + +## Version handling + +bump-my-version abstracts the version handling into a few concepts: + +A **version spec** defines all the possible _version component specs_ of a version and how they work together. + +A **version component spec** defines how a single part of a _version spec,_ such as `major`, `minor`, or `patch`, works. It defines the types of values, how to increment the component, and how to reset it. + +A **version parser** is a regular expression used in several ways. It's named capture groups define the possible components in a version spec and the order in which they appear. It is also used to parse a version string into a mapping of version component name to value. + +A **version** is the concrete representation of a _version spec._ It is a mapping of version component names to _version components._ + +A **version component** is the concrete representation of a _version component spec._ It is a _version component spec_ with a specific value. + +A **version serialization format** is a list of format strings used to serialize a _version_ into a string. + +### How a version spec is generated + +:::{figure-md} fig-version-spec +![How a version spec is generated](../_static/creating-a-version-spec.svg) + +How a configuration file is used to generate a version spec. +::: + +The most important part of the configuration file is the _version parser._ It defines the structure of the _version spec._ + + +If the configuration file contains a _version component spec_ that matches a named capture group in the _version parser,_ then that _version component spec_ is used in the _version spec._ The yellow and green named capture groups in the diagram demonstrate this. + +If the configuration file does not contain a _version component spec_ that matches a named capture group in the _version parser,_ then a default _version component spec_ is used. The blue named capture group in the diagram demonstrates this. + +The _component dependency_ graph is used to determine the order in which the _version components_ are incremented and reset. For example in the diagram, the `patch` component depends on the `minor` component which depends on the `major` component. Therefore, when the `major` component is incremented, the `minor` component is reset, which cascades to the `patch` component. + +### How a version is generated + +:::{figure-md} fig-version +![How a version is generated](../_static/creating-a-version.svg) + +How a version spec is used to generate a version. +::: + +The _version spec_ has a `create_version` method that takes a mapping of version component names to values. + +Each _version component spec_ has a `create_component` method that takes a value. The `create_version` method calls the `create_component` method for each _version component spec_ in the _version spec_ with the value from the mapping. + +The `create_component` assembles its own _version spec_ with the _version components_ to create a _version._ + +### How a version is serialized + +**Optional value rule.** _Version component specs_ can define an optional value. For example, numeric components have `0` as an optional value. Optional values may be omitted from the serialization as long as all dependent components also have optional values. + +**Required value rule.** _Version component specs_ is required if its value or the value of any of its dependent components is not optional. + +A valid serialization is one that contains all the components in the _version spec_ that are required based on the _required value rule._ + +An invalid serialization is one that does not contain all the components in the _version spec_ that are required based on the _required value rule._ + +An optimal serialization is the valid serialization that uses the fewest components. + +The `serialize` method of the _version spec_ returns either the optimal serialization or the first invalid serialization. + +:::{figure-md} fig-serialize-1-2-3 +![How a version is serialized with values major=1, minor=2, and patch=3](../_static/serializing-a-version-1-2-3.svg) + +A version with values major=1, minor=2, and patch=3 only has one valid serialization. It is also the optimal serialization. +::: + +:::{figure-md} fig-serialize-1-2-0 +![How a version is serialized with values major=1, minor=2, and patch=0](../_static/serializing-a-version-1-2-0.svg) + +A version with values major=1, minor=2, and patch=0 has two valid serializations. The optimal serialization is the one that uses the fewest components. `1.2` in this example +::: + +:::{figure-md} fig-serialize-1-0-0 +![How a version is serialized with values major=1, minor=0, and patch=0](../_static/serializing-a-version-1-0-0.svg) + +A version with values major=1, minor=0, and patch=0 has three valid serializations. The optimal serialization is the one that uses the fewest components. `1` in this example. +::: + +:::{figure-md} fig-serialize-1 +![How a version is serialized with invalid serialization formats](../_static/serializing-a-version-1.svg) + +A version with values major=1, minor=2, and patch=3 has no valid serializations in this example. The `serialize` method returns the first invalid serialization. +::: diff --git a/docsrc/reference/bumpversion/bumpversion.__main__.md b/docsrc/reference/bumpversion/bumpversion.__main__.md index a504d450..7807c995 100644 --- a/docsrc/reference/bumpversion/bumpversion.__main__.md +++ b/docsrc/reference/bumpversion/bumpversion.__main__.md @@ -4,5 +4,6 @@ ``` ```{autodoc2-docstring} bumpversion.__main__ +:parser: myst :allowtitles: ``` diff --git a/docsrc/reference/bumpversion/bumpversion.aliases.md b/docsrc/reference/bumpversion/bumpversion.aliases.md index 579c985b..0de83671 100644 --- a/docsrc/reference/bumpversion/bumpversion.aliases.md +++ b/docsrc/reference/bumpversion/bumpversion.aliases.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.aliases +:parser: myst :allowtitles: ``` @@ -17,6 +18,7 @@ * - {py:obj}`AliasedGroup ` - ```{autodoc2-docstring} bumpversion.aliases.AliasedGroup + :parser: myst :summary: ``` ```` @@ -29,18 +31,21 @@ Bases: {py:obj}`rich_click.rich_group.RichGroup` ```{autodoc2-docstring} bumpversion.aliases.AliasedGroup +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.aliases.AliasedGroup.__init__ +:parser: myst ``` ````{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 +:parser: myst ``` ```` @@ -49,6 +54,7 @@ Bases: {py:obj}`rich_click.rich_group.RichGroup` :canonical: bumpversion.aliases.AliasedGroup.resolve_command ```{autodoc2-docstring} bumpversion.aliases.AliasedGroup.resolve_command +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.autocast.md b/docsrc/reference/bumpversion/bumpversion.autocast.md index f08afbbe..065330d3 100644 --- a/docsrc/reference/bumpversion/bumpversion.autocast.md +++ b/docsrc/reference/bumpversion/bumpversion.autocast.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.autocast +:parser: myst :allowtitles: ``` @@ -17,18 +18,22 @@ * - {py:obj}`boolify ` - ```{autodoc2-docstring} bumpversion.autocast.boolify + :parser: myst :summary: ``` * - {py:obj}`noneify ` - ```{autodoc2-docstring} bumpversion.autocast.noneify + :parser: myst :summary: ``` * - {py:obj}`listify ` - ```{autodoc2-docstring} bumpversion.autocast.listify + :parser: myst :summary: ``` * - {py:obj}`autocast_value ` - ```{autodoc2-docstring} bumpversion.autocast.autocast_value + :parser: myst :summary: ``` ```` @@ -39,6 +44,7 @@ :canonical: bumpversion.autocast.boolify ```{autodoc2-docstring} bumpversion.autocast.boolify +:parser: myst ``` ```` @@ -46,6 +52,7 @@ :canonical: bumpversion.autocast.noneify ```{autodoc2-docstring} bumpversion.autocast.noneify +:parser: myst ``` ```` @@ -53,6 +60,7 @@ :canonical: bumpversion.autocast.listify ```{autodoc2-docstring} bumpversion.autocast.listify +:parser: myst ``` ```` @@ -60,5 +68,6 @@ :canonical: bumpversion.autocast.autocast_value ```{autodoc2-docstring} bumpversion.autocast.autocast_value +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.bump.md b/docsrc/reference/bumpversion/bumpversion.bump.md index 8e765bb1..3cf4358c 100644 --- a/docsrc/reference/bumpversion/bumpversion.bump.md +++ b/docsrc/reference/bumpversion/bumpversion.bump.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.bump +:parser: myst :allowtitles: ``` @@ -17,14 +18,17 @@ * - {py:obj}`get_next_version ` - ```{autodoc2-docstring} bumpversion.bump.get_next_version + :parser: myst :summary: ``` * - {py:obj}`do_bump ` - ```{autodoc2-docstring} bumpversion.bump.do_bump + :parser: myst :summary: ``` * - {py:obj}`commit_and_tag ` - ```{autodoc2-docstring} bumpversion.bump.commit_and_tag + :parser: myst :summary: ``` ```` @@ -37,6 +41,7 @@ * - {py:obj}`logger ` - ```{autodoc2-docstring} bumpversion.bump.logger + :parser: myst :summary: ``` ```` @@ -49,14 +54,16 @@ 'get_indented_logger(...)' ```{autodoc2-docstring} bumpversion.bump.logger +:parser: myst ``` ```` -````{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 +````{py:function} get_next_version(current_version: bumpversion.versioning.models.Version, config: bumpversion.config.Config, version_part: typing.Optional[str], new_version: typing.Optional[str]) -> bumpversion.versioning.models.Version :canonical: bumpversion.bump.get_next_version ```{autodoc2-docstring} bumpversion.bump.get_next_version +:parser: myst ``` ```` @@ -64,6 +71,7 @@ :canonical: bumpversion.bump.do_bump ```{autodoc2-docstring} bumpversion.bump.do_bump +:parser: myst ``` ```` @@ -71,5 +79,6 @@ :canonical: bumpversion.bump.commit_and_tag ```{autodoc2-docstring} bumpversion.bump.commit_and_tag +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.cli.md b/docsrc/reference/bumpversion/bumpversion.cli.md index 11244357..87d44c40 100644 --- a/docsrc/reference/bumpversion/bumpversion.cli.md +++ b/docsrc/reference/bumpversion/bumpversion.cli.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.cli +:parser: myst :allowtitles: ``` @@ -17,26 +18,32 @@ * - {py:obj}`cli ` - ```{autodoc2-docstring} bumpversion.cli.cli + :parser: myst :summary: ``` * - {py:obj}`bump ` - ```{autodoc2-docstring} bumpversion.cli.bump + :parser: myst :summary: ``` * - {py:obj}`show ` - ```{autodoc2-docstring} bumpversion.cli.show + :parser: myst :summary: ``` * - {py:obj}`replace ` - ```{autodoc2-docstring} bumpversion.cli.replace + :parser: myst :summary: ``` * - {py:obj}`sample_config ` - ```{autodoc2-docstring} bumpversion.cli.sample_config + :parser: myst :summary: ``` * - {py:obj}`show_bump ` - ```{autodoc2-docstring} bumpversion.cli.show_bump + :parser: myst :summary: ``` ```` @@ -49,6 +56,7 @@ * - {py:obj}`logger ` - ```{autodoc2-docstring} bumpversion.cli.logger + :parser: myst :summary: ``` ```` @@ -61,6 +69,7 @@ 'get_indented_logger(...)' ```{autodoc2-docstring} bumpversion.cli.logger +:parser: myst ``` ```` @@ -69,6 +78,7 @@ :canonical: bumpversion.cli.cli ```{autodoc2-docstring} bumpversion.cli.cli +:parser: myst ``` ```` @@ -76,6 +86,7 @@ :canonical: bumpversion.cli.bump ```{autodoc2-docstring} bumpversion.cli.bump +:parser: myst ``` ```` @@ -83,6 +94,7 @@ :canonical: bumpversion.cli.show ```{autodoc2-docstring} bumpversion.cli.show +:parser: myst ``` ```` @@ -90,6 +102,7 @@ :canonical: bumpversion.cli.replace ```{autodoc2-docstring} bumpversion.cli.replace +:parser: myst ``` ```` @@ -97,6 +110,7 @@ :canonical: bumpversion.cli.sample_config ```{autodoc2-docstring} bumpversion.cli.sample_config +:parser: myst ``` ```` @@ -104,5 +118,6 @@ :canonical: bumpversion.cli.show_bump ```{autodoc2-docstring} bumpversion.cli.show_bump +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.config.create.md b/docsrc/reference/bumpversion/bumpversion.config.create.md index 2a59dae8..18cee559 100644 --- a/docsrc/reference/bumpversion/bumpversion.config.create.md +++ b/docsrc/reference/bumpversion/bumpversion.config.create.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.config.create +:parser: myst :allowtitles: ``` @@ -17,10 +18,12 @@ * - {py:obj}`create_configuration ` - ```{autodoc2-docstring} bumpversion.config.create.create_configuration + :parser: myst :summary: ``` * - {py:obj}`get_defaults_from_dest ` - ```{autodoc2-docstring} bumpversion.config.create.get_defaults_from_dest + :parser: myst :summary: ``` ```` @@ -31,6 +34,7 @@ :canonical: bumpversion.config.create.create_configuration ```{autodoc2-docstring} bumpversion.config.create.create_configuration +:parser: myst ``` ```` @@ -38,5 +42,6 @@ :canonical: bumpversion.config.create.get_defaults_from_dest ```{autodoc2-docstring} bumpversion.config.create.get_defaults_from_dest +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.config.files.md b/docsrc/reference/bumpversion/bumpversion.config.files.md index 9beb1c4e..c32aff82 100644 --- a/docsrc/reference/bumpversion/bumpversion.config.files.md +++ b/docsrc/reference/bumpversion/bumpversion.config.files.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.config.files +:parser: myst :allowtitles: ``` @@ -17,18 +18,22 @@ * - {py:obj}`find_config_file ` - ```{autodoc2-docstring} bumpversion.config.files.find_config_file + :parser: myst :summary: ``` * - {py:obj}`read_config_file ` - ```{autodoc2-docstring} bumpversion.config.files.read_config_file + :parser: myst :summary: ``` * - {py:obj}`read_toml_file ` - ```{autodoc2-docstring} bumpversion.config.files.read_toml_file + :parser: myst :summary: ``` * - {py:obj}`update_config_file ` - ```{autodoc2-docstring} bumpversion.config.files.update_config_file + :parser: myst :summary: ``` ```` @@ -41,10 +46,12 @@ * - {py:obj}`logger ` - ```{autodoc2-docstring} bumpversion.config.files.logger + :parser: myst :summary: ``` * - {py:obj}`CONFIG_FILE_SEARCH_ORDER ` - ```{autodoc2-docstring} bumpversion.config.files.CONFIG_FILE_SEARCH_ORDER + :parser: myst :summary: ``` ```` @@ -57,6 +64,7 @@ 'get_indented_logger(...)' ```{autodoc2-docstring} bumpversion.config.files.logger +:parser: myst ``` ```` @@ -67,6 +75,7 @@ ('.bumpversion.cfg', '.bumpversion.toml', 'setup.cfg', 'pyproject.toml') ```{autodoc2-docstring} bumpversion.config.files.CONFIG_FILE_SEARCH_ORDER +:parser: myst ``` ```` @@ -75,6 +84,7 @@ :canonical: bumpversion.config.files.find_config_file ```{autodoc2-docstring} bumpversion.config.files.find_config_file +:parser: myst ``` ```` @@ -82,6 +92,7 @@ :canonical: bumpversion.config.files.read_config_file ```{autodoc2-docstring} bumpversion.config.files.read_config_file +:parser: myst ``` ```` @@ -89,12 +100,14 @@ :canonical: bumpversion.config.files.read_toml_file ```{autodoc2-docstring} bumpversion.config.files.read_toml_file +:parser: myst ``` ```` -````{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 +````{py:function} update_config_file(config_file: typing.Union[str, pathlib.Path], config: bumpversion.config.models.Config, current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: typing.MutableMapping, dry_run: bool = False) -> None :canonical: bumpversion.config.files.update_config_file ```{autodoc2-docstring} bumpversion.config.files.update_config_file +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.config.files_legacy.md b/docsrc/reference/bumpversion/bumpversion.config.files_legacy.md index 1b856036..69a0c19f 100644 --- a/docsrc/reference/bumpversion/bumpversion.config.files_legacy.md +++ b/docsrc/reference/bumpversion/bumpversion.config.files_legacy.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.config.files_legacy +:parser: myst :allowtitles: ``` @@ -17,10 +18,12 @@ * - {py:obj}`read_ini_file ` - ```{autodoc2-docstring} bumpversion.config.files_legacy.read_ini_file + :parser: myst :summary: ``` * - {py:obj}`update_ini_config_file ` - ```{autodoc2-docstring} bumpversion.config.files_legacy.update_ini_config_file + :parser: myst :summary: ``` ```` @@ -33,6 +36,7 @@ * - {py:obj}`logger ` - ```{autodoc2-docstring} bumpversion.config.files_legacy.logger + :parser: myst :summary: ``` ```` @@ -45,6 +49,7 @@ 'get_indented_logger(...)' ```{autodoc2-docstring} bumpversion.config.files_legacy.logger +:parser: myst ``` ```` @@ -53,6 +58,7 @@ :canonical: bumpversion.config.files_legacy.read_ini_file ```{autodoc2-docstring} bumpversion.config.files_legacy.read_ini_file +:parser: myst ``` ```` @@ -60,5 +66,6 @@ :canonical: bumpversion.config.files_legacy.update_ini_config_file ```{autodoc2-docstring} bumpversion.config.files_legacy.update_ini_config_file +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.config.md b/docsrc/reference/bumpversion/bumpversion.config.md index 3c4b3b50..60a744d0 100644 --- a/docsrc/reference/bumpversion/bumpversion.config.md +++ b/docsrc/reference/bumpversion/bumpversion.config.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.config +:parser: myst :allowtitles: ``` @@ -30,10 +31,12 @@ bumpversion.config.utils * - {py:obj}`get_configuration ` - ```{autodoc2-docstring} bumpversion.config.get_configuration + :parser: myst :summary: ``` * - {py:obj}`check_current_version ` - ```{autodoc2-docstring} bumpversion.config.check_current_version + :parser: myst :summary: ``` ```` @@ -46,10 +49,12 @@ bumpversion.config.utils * - {py:obj}`logger ` - ```{autodoc2-docstring} bumpversion.config.logger + :parser: myst :summary: ``` * - {py:obj}`DEFAULTS ` - ```{autodoc2-docstring} bumpversion.config.DEFAULTS + :parser: myst :summary: ``` ```` @@ -62,6 +67,7 @@ bumpversion.config.utils 'get_indented_logger(...)' ```{autodoc2-docstring} bumpversion.config.logger +:parser: myst ``` ```` @@ -72,6 +78,7 @@ bumpversion.config.utils None ```{autodoc2-docstring} bumpversion.config.DEFAULTS +:parser: myst ``` ```` @@ -80,6 +87,7 @@ bumpversion.config.utils :canonical: bumpversion.config.get_configuration ```{autodoc2-docstring} bumpversion.config.get_configuration +:parser: myst ``` ```` @@ -87,5 +95,6 @@ bumpversion.config.utils :canonical: bumpversion.config.check_current_version ```{autodoc2-docstring} bumpversion.config.check_current_version +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.config.models.md b/docsrc/reference/bumpversion/bumpversion.config.models.md index b670f76f..18034e92 100644 --- a/docsrc/reference/bumpversion/bumpversion.config.models.md +++ b/docsrc/reference/bumpversion/bumpversion.config.models.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.config.models +:parser: myst :allowtitles: ``` @@ -15,16 +16,14 @@ :class: autosummary longtable :align: left -* - {py:obj}`VersionPartConfig ` - - ```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig - :summary: - ``` * - {py:obj}`FileChange ` - ```{autodoc2-docstring} bumpversion.config.models.FileChange + :parser: myst :summary: ``` * - {py:obj}`Config ` - ```{autodoc2-docstring} bumpversion.config.models.Config + :parser: myst :summary: ``` ```` @@ -37,6 +36,7 @@ * - {py:obj}`logger ` - ```{autodoc2-docstring} bumpversion.config.models.logger + :parser: myst :summary: ``` ```` @@ -49,82 +49,25 @@ 'get_indented_logger(...)' ```{autodoc2-docstring} bumpversion.config.models.logger +:parser: myst ``` ```` -`````{py:class} VersionPartConfig(**data: typing.Any) -:canonical: bumpversion.config.models.VersionPartConfig - -Bases: {py:obj}`pydantic.BaseModel` - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig -``` - -```{rubric} Initialization -``` - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig.__init__ -``` - -````{py:attribute} values -:canonical: bumpversion.config.models.VersionPartConfig.values -:type: typing.Optional[list] -:value: > - None - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig.values -``` - -```` - -````{py:attribute} optional_value -:canonical: bumpversion.config.models.VersionPartConfig.optional_value -:type: typing.Optional[str] -:value: > - None - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig.optional_value -``` - -```` - -````{py:attribute} first_value -:canonical: bumpversion.config.models.VersionPartConfig.first_value -:type: typing.Union[str, int, None] -:value: > - None - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig.first_value -``` - -```` - -````{py:attribute} independent -:canonical: bumpversion.config.models.VersionPartConfig.independent -:type: bool -:value: > - False - -```{autodoc2-docstring} bumpversion.config.models.VersionPartConfig.independent -``` - -```` - -````` - `````{py:class} FileChange(**data: typing.Any) :canonical: bumpversion.config.models.FileChange Bases: {py:obj}`pydantic.BaseModel` ```{autodoc2-docstring} bumpversion.config.models.FileChange +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.config.models.FileChange.__init__ +:parser: myst ``` ````{py:attribute} parse @@ -134,6 +77,7 @@ Bases: {py:obj}`pydantic.BaseModel` None ```{autodoc2-docstring} bumpversion.config.models.FileChange.parse +:parser: myst ``` ```` @@ -145,6 +89,7 @@ Bases: {py:obj}`pydantic.BaseModel` None ```{autodoc2-docstring} bumpversion.config.models.FileChange.serialize +:parser: myst ``` ```` @@ -156,6 +101,7 @@ Bases: {py:obj}`pydantic.BaseModel` None ```{autodoc2-docstring} bumpversion.config.models.FileChange.search +:parser: myst ``` ```` @@ -167,6 +113,7 @@ Bases: {py:obj}`pydantic.BaseModel` None ```{autodoc2-docstring} bumpversion.config.models.FileChange.replace +:parser: myst ``` ```` @@ -178,6 +125,7 @@ Bases: {py:obj}`pydantic.BaseModel` None ```{autodoc2-docstring} bumpversion.config.models.FileChange.regex +:parser: myst ``` ```` @@ -189,6 +137,7 @@ Bases: {py:obj}`pydantic.BaseModel` None ```{autodoc2-docstring} bumpversion.config.models.FileChange.ignore_missing_version +:parser: myst ``` ```` @@ -200,6 +149,7 @@ Bases: {py:obj}`pydantic.BaseModel` None ```{autodoc2-docstring} bumpversion.config.models.FileChange.filename +:parser: myst ``` ```` @@ -211,6 +161,7 @@ Bases: {py:obj}`pydantic.BaseModel` None ```{autodoc2-docstring} bumpversion.config.models.FileChange.glob +:parser: myst ``` ```` @@ -222,6 +173,7 @@ Bases: {py:obj}`pydantic.BaseModel` None ```{autodoc2-docstring} bumpversion.config.models.FileChange.key_path +:parser: myst ``` ```` @@ -230,6 +182,7 @@ Bases: {py:obj}`pydantic.BaseModel` :canonical: bumpversion.config.models.FileChange.__hash__ ```{autodoc2-docstring} bumpversion.config.models.FileChange.__hash__ +:parser: myst ``` ```` @@ -238,6 +191,7 @@ Bases: {py:obj}`pydantic.BaseModel` :canonical: bumpversion.config.models.FileChange.get_search_pattern ```{autodoc2-docstring} bumpversion.config.models.FileChange.get_search_pattern +:parser: myst ``` ```` @@ -250,12 +204,14 @@ Bases: {py:obj}`pydantic.BaseModel` Bases: {py:obj}`pydantic_settings.BaseSettings` ```{autodoc2-docstring} bumpversion.config.models.Config +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.config.models.Config.__init__ +:parser: myst ``` ````{py:attribute} current_version @@ -265,6 +221,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.current_version +:parser: myst ``` ```` @@ -276,6 +233,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.parse +:parser: myst ``` ```` @@ -287,6 +245,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` 'Field(...)' ```{autodoc2-docstring} bumpversion.config.models.Config.serialize +:parser: myst ``` ```` @@ -298,6 +257,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.search +:parser: myst ``` ```` @@ -309,6 +269,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.replace +:parser: myst ``` ```` @@ -320,6 +281,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.regex +:parser: myst ``` ```` @@ -331,6 +293,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.ignore_missing_version +:parser: myst ``` ```` @@ -342,6 +305,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.tag +:parser: myst ``` ```` @@ -353,6 +317,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.sign_tags +:parser: myst ``` ```` @@ -364,6 +329,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.tag_name +:parser: myst ``` ```` @@ -375,6 +341,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.tag_message +:parser: myst ``` ```` @@ -386,6 +353,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.allow_dirty +:parser: myst ``` ```` @@ -397,6 +365,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.commit +:parser: myst ``` ```` @@ -408,6 +377,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.message +:parser: myst ``` ```` @@ -419,6 +389,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.commit_args +:parser: myst ``` ```` @@ -430,17 +401,19 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config.scm_info +:parser: myst ``` ```` ````{py:attribute} parts :canonical: bumpversion.config.models.Config.parts -:type: typing.Dict[str, bumpversion.config.models.VersionPartConfig] +:type: typing.Dict[str, bumpversion.versioning.models.VersionComponentSpec] :value: > None ```{autodoc2-docstring} bumpversion.config.models.Config.parts +:parser: myst ``` ```` @@ -452,6 +425,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` 'Field(...)' ```{autodoc2-docstring} bumpversion.config.models.Config.files +:parser: myst ``` ```` @@ -463,6 +437,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` 'Field(...)' ```{autodoc2-docstring} bumpversion.config.models.Config.included_paths +:parser: myst ``` ```` @@ -474,6 +449,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` 'Field(...)' ```{autodoc2-docstring} bumpversion.config.models.Config.excluded_paths +:parser: myst ``` ```` @@ -484,6 +460,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` 'SettingsConfigDict(...)' ```{autodoc2-docstring} bumpversion.config.models.Config.model_config +:parser: myst ``` ```` @@ -495,6 +472,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` None ```{autodoc2-docstring} bumpversion.config.models.Config._resolved_filemap +:parser: myst ``` ```` @@ -503,6 +481,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` :canonical: bumpversion.config.models.Config.add_files ```{autodoc2-docstring} bumpversion.config.models.Config.add_files +:parser: myst ``` ```` @@ -512,6 +491,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` :type: typing.Dict[str, typing.List[bumpversion.config.models.FileChange]] ```{autodoc2-docstring} bumpversion.config.models.Config.resolved_filemap +:parser: myst ``` ```` @@ -520,6 +500,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` :canonical: bumpversion.config.models.Config._resolve_filemap ```{autodoc2-docstring} bumpversion.config.models.Config._resolve_filemap +:parser: myst ``` ```` @@ -529,6 +510,7 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` :type: typing.List[bumpversion.config.models.FileChange] ```{autodoc2-docstring} bumpversion.config.models.Config.files_to_modify +:parser: myst ``` ```` @@ -538,6 +520,16 @@ Bases: {py:obj}`pydantic_settings.BaseSettings` :type: bumpversion.version_part.VersionConfig ```{autodoc2-docstring} bumpversion.config.models.Config.version_config +:parser: myst +``` + +```` + +````{py:method} version_spec(version: typing.Optional[str] = None) -> bumpversion.versioning.models.VersionSpec +:canonical: bumpversion.config.models.Config.version_spec + +```{autodoc2-docstring} bumpversion.config.models.Config.version_spec +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.config.utils.md b/docsrc/reference/bumpversion/bumpversion.config.utils.md index 9d7e45e9..e0c481fd 100644 --- a/docsrc/reference/bumpversion/bumpversion.config.utils.md +++ b/docsrc/reference/bumpversion/bumpversion.config.utils.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.config.utils +:parser: myst :allowtitles: ``` @@ -17,14 +18,17 @@ * - {py:obj}`get_all_file_configs ` - ```{autodoc2-docstring} bumpversion.config.utils.get_all_file_configs + :parser: myst :summary: ``` * - {py:obj}`get_all_part_configs ` - ```{autodoc2-docstring} bumpversion.config.utils.get_all_part_configs + :parser: myst :summary: ``` * - {py:obj}`resolve_glob_files ` - ```{autodoc2-docstring} bumpversion.config.utils.resolve_glob_files + :parser: myst :summary: ``` ```` @@ -35,13 +39,15 @@ :canonical: bumpversion.config.utils.get_all_file_configs ```{autodoc2-docstring} bumpversion.config.utils.get_all_file_configs +:parser: myst ``` ```` -````{py:function} get_all_part_configs(config_dict: dict) -> typing.Dict[str, bumpversion.config.models.VersionPartConfig] +````{py:function} get_all_part_configs(config_dict: dict) -> typing.Dict[str, bumpversion.versioning.models.VersionComponentSpec] :canonical: bumpversion.config.utils.get_all_part_configs ```{autodoc2-docstring} bumpversion.config.utils.get_all_part_configs +:parser: myst ``` ```` @@ -49,5 +55,6 @@ :canonical: bumpversion.config.utils.resolve_glob_files ```{autodoc2-docstring} bumpversion.config.utils.resolve_glob_files +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.exceptions.md b/docsrc/reference/bumpversion/bumpversion.exceptions.md index 277c9cef..9aabf6b0 100644 --- a/docsrc/reference/bumpversion/bumpversion.exceptions.md +++ b/docsrc/reference/bumpversion/bumpversion.exceptions.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.exceptions +:parser: myst :allowtitles: ``` @@ -17,12 +18,14 @@ Bases: {py:obj}`click.UsageError` ```{autodoc2-docstring} bumpversion.exceptions.BumpVersionError +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.exceptions.BumpVersionError.__init__ +:parser: myst ``` ```` @@ -33,12 +36,14 @@ Bases: {py:obj}`click.UsageError` Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` ```{autodoc2-docstring} bumpversion.exceptions.FormattingError +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.exceptions.FormattingError.__init__ +:parser: myst ``` ```` @@ -49,12 +54,14 @@ Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` ```{autodoc2-docstring} bumpversion.exceptions.MissingValueError +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.exceptions.MissingValueError.__init__ +:parser: myst ``` ```` @@ -65,12 +72,14 @@ Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` ```{autodoc2-docstring} bumpversion.exceptions.DirtyWorkingDirectoryError +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.exceptions.DirtyWorkingDirectoryError.__init__ +:parser: myst ``` ```` @@ -81,12 +90,14 @@ Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` ```{autodoc2-docstring} bumpversion.exceptions.SignedTagsError +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.exceptions.SignedTagsError.__init__ +:parser: myst ``` ```` @@ -97,12 +108,14 @@ Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` ```{autodoc2-docstring} bumpversion.exceptions.VersionNotFoundError +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.exceptions.VersionNotFoundError.__init__ +:parser: myst ``` ```` @@ -113,12 +126,14 @@ Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` ```{autodoc2-docstring} bumpversion.exceptions.InvalidVersionPartError +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.exceptions.InvalidVersionPartError.__init__ +:parser: myst ``` ```` @@ -129,12 +144,14 @@ Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` ```{autodoc2-docstring} bumpversion.exceptions.ConfigurationError +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.exceptions.ConfigurationError.__init__ +:parser: myst ``` ```` @@ -145,12 +162,14 @@ Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` Bases: {py:obj}`bumpversion.exceptions.BumpVersionError` ```{autodoc2-docstring} bumpversion.exceptions.BadInputError +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.exceptions.BadInputError.__init__ +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.files.md b/docsrc/reference/bumpversion/bumpversion.files.md index 2257aeeb..66835fb7 100644 --- a/docsrc/reference/bumpversion/bumpversion.files.md +++ b/docsrc/reference/bumpversion/bumpversion.files.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.files +:parser: myst :allowtitles: ``` @@ -17,14 +18,17 @@ * - {py:obj}`ConfiguredFile ` - ```{autodoc2-docstring} bumpversion.files.ConfiguredFile + :parser: myst :summary: ``` * - {py:obj}`FileUpdater ` - ```{autodoc2-docstring} bumpversion.files.FileUpdater + :parser: myst :summary: ``` * - {py:obj}`DataFileUpdater ` - ```{autodoc2-docstring} bumpversion.files.DataFileUpdater + :parser: myst :summary: ``` ```` @@ -37,18 +41,22 @@ * - {py:obj}`contains_pattern ` - ```{autodoc2-docstring} bumpversion.files.contains_pattern + :parser: myst :summary: ``` * - {py:obj}`log_changes ` - ```{autodoc2-docstring} bumpversion.files.log_changes + :parser: myst :summary: ``` * - {py:obj}`resolve_file_config ` - ```{autodoc2-docstring} bumpversion.files.resolve_file_config + :parser: myst :summary: ``` * - {py:obj}`modify_files ` - ```{autodoc2-docstring} bumpversion.files.modify_files + :parser: myst :summary: ``` ```` @@ -61,6 +69,7 @@ * - {py:obj}`logger ` - ```{autodoc2-docstring} bumpversion.files.logger + :parser: myst :summary: ``` ```` @@ -73,6 +82,7 @@ 'get_indented_logger(...)' ```{autodoc2-docstring} bumpversion.files.logger +:parser: myst ``` ```` @@ -81,6 +91,7 @@ :canonical: bumpversion.files.contains_pattern ```{autodoc2-docstring} bumpversion.files.contains_pattern +:parser: myst ``` ```` @@ -88,6 +99,7 @@ :canonical: bumpversion.files.log_changes ```{autodoc2-docstring} bumpversion.files.log_changes +:parser: myst ``` ```` @@ -95,18 +107,21 @@ :canonical: bumpversion.files.ConfiguredFile ```{autodoc2-docstring} bumpversion.files.ConfiguredFile +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.files.ConfiguredFile.__init__ +:parser: myst ``` ````{py:method} get_file_contents() -> str :canonical: bumpversion.files.ConfiguredFile.get_file_contents ```{autodoc2-docstring} bumpversion.files.ConfiguredFile.get_file_contents +:parser: myst ``` ```` @@ -115,22 +130,25 @@ :canonical: bumpversion.files.ConfiguredFile.write_file_contents ```{autodoc2-docstring} bumpversion.files.ConfiguredFile.write_file_contents +:parser: myst ``` ```` -````{py:method} _contains_change_pattern(search_expression: re.Pattern, raw_search_expression: str, version: bumpversion.version_part.Version, context: typing.MutableMapping) -> bool +````{py:method} _contains_change_pattern(search_expression: re.Pattern, raw_search_expression: str, version: bumpversion.versioning.models.Version, context: typing.MutableMapping) -> bool :canonical: bumpversion.files.ConfiguredFile._contains_change_pattern ```{autodoc2-docstring} bumpversion.files.ConfiguredFile._contains_change_pattern +:parser: myst ``` ```` -````{py:method} make_file_change(current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: typing.MutableMapping, dry_run: bool = False) -> None +````{py:method} make_file_change(current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: typing.MutableMapping, dry_run: bool = False) -> None :canonical: bumpversion.files.ConfiguredFile.make_file_change ```{autodoc2-docstring} bumpversion.files.ConfiguredFile.make_file_change +:parser: myst ``` ```` @@ -151,13 +169,15 @@ :canonical: bumpversion.files.resolve_file_config ```{autodoc2-docstring} bumpversion.files.resolve_file_config +:parser: myst ``` ```` -````{py:function} modify_files(files: typing.List[bumpversion.files.ConfiguredFile], current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: typing.MutableMapping, dry_run: bool = False) -> None +````{py:function} modify_files(files: typing.List[bumpversion.files.ConfiguredFile], current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: typing.MutableMapping, dry_run: bool = False) -> None :canonical: bumpversion.files.modify_files ```{autodoc2-docstring} bumpversion.files.modify_files +:parser: myst ``` ```` @@ -165,40 +185,46 @@ :canonical: bumpversion.files.FileUpdater ```{autodoc2-docstring} bumpversion.files.FileUpdater +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.files.FileUpdater.__init__ +:parser: myst ``` -````{py:method} update_file(current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: typing.MutableMapping, dry_run: bool = False) -> None +````{py:method} update_file(current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: typing.MutableMapping, dry_run: bool = False) -> None :canonical: bumpversion.files.FileUpdater.update_file ```{autodoc2-docstring} bumpversion.files.FileUpdater.update_file +:parser: myst ``` ```` ````` -`````{py:class} DataFileUpdater(file_change: bumpversion.config.models.FileChange, version_part_configs: typing.Dict[str, bumpversion.config.models.VersionPartConfig]) +`````{py:class} DataFileUpdater(file_change: bumpversion.config.models.FileChange, version_part_configs: typing.Dict[str, bumpversion.versioning.models.VersionComponentSpec]) :canonical: bumpversion.files.DataFileUpdater ```{autodoc2-docstring} bumpversion.files.DataFileUpdater +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.files.DataFileUpdater.__init__ +:parser: myst ``` -````{py:method} update_file(current_version: bumpversion.version_part.Version, new_version: bumpversion.version_part.Version, context: typing.MutableMapping, dry_run: bool = False) -> None +````{py:method} update_file(current_version: bumpversion.versioning.models.Version, new_version: bumpversion.versioning.models.Version, context: typing.MutableMapping, dry_run: bool = False) -> None :canonical: bumpversion.files.DataFileUpdater.update_file ```{autodoc2-docstring} bumpversion.files.DataFileUpdater.update_file +:parser: myst ``` ```` @@ -207,6 +233,7 @@ :canonical: bumpversion.files.DataFileUpdater._update_toml_file ```{autodoc2-docstring} bumpversion.files.DataFileUpdater._update_toml_file +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.functions.md b/docsrc/reference/bumpversion/bumpversion.functions.md deleted file mode 100644 index 04e75998..00000000 --- a/docsrc/reference/bumpversion/bumpversion.functions.md +++ /dev/null @@ -1,140 +0,0 @@ -# {py:mod}`bumpversion.functions` - -```{py:module} bumpversion.functions -``` - -```{autodoc2-docstring} bumpversion.functions -:allowtitles: -``` - -## Module Contents - -### Classes - -````{list-table} -:class: autosummary longtable -:align: left - -* - {py:obj}`PartFunction ` - - ```{autodoc2-docstring} bumpversion.functions.PartFunction - :summary: - ``` -* - {py:obj}`NumericFunction ` - - ```{autodoc2-docstring} bumpversion.functions.NumericFunction - :summary: - ``` -* - {py:obj}`ValuesFunction ` - - ```{autodoc2-docstring} bumpversion.functions.ValuesFunction - :summary: - ``` -```` - -### API - -`````{py:class} PartFunction -:canonical: bumpversion.functions.PartFunction - -```{autodoc2-docstring} bumpversion.functions.PartFunction -``` - -````{py:attribute} first_value -:canonical: bumpversion.functions.PartFunction.first_value -:type: str -:value: > - None - -```{autodoc2-docstring} bumpversion.functions.PartFunction.first_value -``` - -```` - -````{py:attribute} optional_value -:canonical: bumpversion.functions.PartFunction.optional_value -:type: str -:value: > - None - -```{autodoc2-docstring} bumpversion.functions.PartFunction.optional_value -``` - -```` - -````{py:attribute} independent -:canonical: bumpversion.functions.PartFunction.independent -:type: bool -:value: > - None - -```{autodoc2-docstring} bumpversion.functions.PartFunction.independent -``` - -```` - -````{py:method} bump(value: str) -> str -:canonical: bumpversion.functions.PartFunction.bump -:abstractmethod: - -```{autodoc2-docstring} bumpversion.functions.PartFunction.bump -``` - -```` - -````` - -`````{py:class} NumericFunction(optional_value: typing.Union[str, int, None] = None, first_value: typing.Union[str, int, None] = None) -:canonical: bumpversion.functions.NumericFunction - -Bases: {py:obj}`bumpversion.functions.PartFunction` - -```{autodoc2-docstring} bumpversion.functions.NumericFunction -``` - -```{rubric} Initialization -``` - -```{autodoc2-docstring} bumpversion.functions.NumericFunction.__init__ -``` - -````{py:attribute} FIRST_NUMERIC -:canonical: bumpversion.functions.NumericFunction.FIRST_NUMERIC -:value: > - 'compile(...)' - -```{autodoc2-docstring} bumpversion.functions.NumericFunction.FIRST_NUMERIC -``` - -```` - -````{py:method} bump(value: typing.Union[str, int]) -> str -:canonical: bumpversion.functions.NumericFunction.bump - -```{autodoc2-docstring} bumpversion.functions.NumericFunction.bump -``` - -```` - -````` - -`````{py:class} ValuesFunction(values: typing.List[str], optional_value: typing.Optional[str] = None, first_value: typing.Optional[str] = None) -:canonical: bumpversion.functions.ValuesFunction - -Bases: {py:obj}`bumpversion.functions.PartFunction` - -```{autodoc2-docstring} bumpversion.functions.ValuesFunction -``` - -```{rubric} Initialization -``` - -```{autodoc2-docstring} bumpversion.functions.ValuesFunction.__init__ -``` - -````{py:method} bump(value: str) -> str -:canonical: bumpversion.functions.ValuesFunction.bump - -```{autodoc2-docstring} bumpversion.functions.ValuesFunction.bump -``` - -```` - -````` diff --git a/docsrc/reference/bumpversion/bumpversion.indented_logger.md b/docsrc/reference/bumpversion/bumpversion.indented_logger.md index 40e0b412..6818cb89 100644 --- a/docsrc/reference/bumpversion/bumpversion.indented_logger.md +++ b/docsrc/reference/bumpversion/bumpversion.indented_logger.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.indented_logger +:parser: myst :allowtitles: ``` @@ -17,6 +18,7 @@ * - {py:obj}`IndentedLoggerAdapter ` - ```{autodoc2-docstring} bumpversion.indented_logger.IndentedLoggerAdapter + :parser: myst :summary: ``` ```` @@ -29,6 +31,7 @@ * - {py:obj}`CURRENT_INDENT ` - ```{autodoc2-docstring} bumpversion.indented_logger.CURRENT_INDENT + :parser: myst :summary: ``` ```` @@ -41,6 +44,7 @@ 'ContextVar(...)' ```{autodoc2-docstring} bumpversion.indented_logger.CURRENT_INDENT +:parser: myst ``` ```` @@ -51,12 +55,14 @@ Bases: {py:obj}`logging.LoggerAdapter` ```{autodoc2-docstring} bumpversion.indented_logger.IndentedLoggerAdapter +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.indented_logger.IndentedLoggerAdapter.__init__ +:parser: myst ``` ````{py:property} current_indent @@ -64,6 +70,7 @@ Bases: {py:obj}`logging.LoggerAdapter` :type: int ```{autodoc2-docstring} bumpversion.indented_logger.IndentedLoggerAdapter.current_indent +:parser: myst ``` ```` @@ -72,6 +79,7 @@ Bases: {py:obj}`logging.LoggerAdapter` :canonical: bumpversion.indented_logger.IndentedLoggerAdapter.indent ```{autodoc2-docstring} bumpversion.indented_logger.IndentedLoggerAdapter.indent +:parser: myst ``` ```` @@ -80,6 +88,7 @@ Bases: {py:obj}`logging.LoggerAdapter` :canonical: bumpversion.indented_logger.IndentedLoggerAdapter.dedent ```{autodoc2-docstring} bumpversion.indented_logger.IndentedLoggerAdapter.dedent +:parser: myst ``` ```` @@ -88,6 +97,7 @@ Bases: {py:obj}`logging.LoggerAdapter` :canonical: bumpversion.indented_logger.IndentedLoggerAdapter.reset ```{autodoc2-docstring} bumpversion.indented_logger.IndentedLoggerAdapter.reset +:parser: myst ``` ```` @@ -97,6 +107,7 @@ Bases: {py:obj}`logging.LoggerAdapter` :type: str ```{autodoc2-docstring} bumpversion.indented_logger.IndentedLoggerAdapter.indent_str +:parser: myst ``` ```` @@ -105,6 +116,7 @@ Bases: {py:obj}`logging.LoggerAdapter` :canonical: bumpversion.indented_logger.IndentedLoggerAdapter.process ```{autodoc2-docstring} bumpversion.indented_logger.IndentedLoggerAdapter.process +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.md b/docsrc/reference/bumpversion/bumpversion.md index f8f225a0..7f9e3fe6 100644 --- a/docsrc/reference/bumpversion/bumpversion.md +++ b/docsrc/reference/bumpversion/bumpversion.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion +:parser: myst :allowtitles: ``` @@ -14,6 +15,7 @@ :maxdepth: 3 bumpversion.config +bumpversion.versioning ``` ## Submodules @@ -22,7 +24,6 @@ bumpversion.config :titlesonly: :maxdepth: 1 -bumpversion.functions bumpversion.version_part bumpversion.files bumpversion.show @@ -50,6 +51,7 @@ bumpversion.__main__ * - {py:obj}`__version__ ` - ```{autodoc2-docstring} bumpversion.__version__ + :parser: myst :summary: ``` ```` @@ -63,6 +65,7 @@ bumpversion.__main__ '0.17.2' ```{autodoc2-docstring} bumpversion.__version__ +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.scm.md b/docsrc/reference/bumpversion/bumpversion.scm.md index 1d6c8599..a4143205 100644 --- a/docsrc/reference/bumpversion/bumpversion.scm.md +++ b/docsrc/reference/bumpversion/bumpversion.scm.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.scm +:parser: myst :allowtitles: ``` @@ -17,18 +18,22 @@ * - {py:obj}`SCMInfo ` - ```{autodoc2-docstring} bumpversion.scm.SCMInfo + :parser: myst :summary: ``` * - {py:obj}`SourceCodeManager ` - ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager + :parser: myst :summary: ``` * - {py:obj}`Git ` - ```{autodoc2-docstring} bumpversion.scm.Git + :parser: myst :summary: ``` * - {py:obj}`Mercurial ` - ```{autodoc2-docstring} bumpversion.scm.Mercurial + :parser: myst :summary: ``` ```` @@ -41,6 +46,7 @@ * - {py:obj}`get_scm_info ` - ```{autodoc2-docstring} bumpversion.scm.get_scm_info + :parser: myst :summary: ``` ```` @@ -53,6 +59,7 @@ * - {py:obj}`logger ` - ```{autodoc2-docstring} bumpversion.scm.logger + :parser: myst :summary: ``` ```` @@ -65,6 +72,7 @@ 'get_indented_logger(...)' ```{autodoc2-docstring} bumpversion.scm.logger +:parser: myst ``` ```` @@ -73,6 +81,7 @@ :canonical: bumpversion.scm.SCMInfo ```{autodoc2-docstring} bumpversion.scm.SCMInfo +:parser: myst ``` ````{py:attribute} tool @@ -82,6 +91,7 @@ None ```{autodoc2-docstring} bumpversion.scm.SCMInfo.tool +:parser: myst ``` ```` @@ -93,17 +103,19 @@ None ```{autodoc2-docstring} bumpversion.scm.SCMInfo.commit_sha +:parser: myst ``` ```` ````{py:attribute} distance_to_latest_tag :canonical: bumpversion.scm.SCMInfo.distance_to_latest_tag -:type: typing.Optional[int] +:type: int :value: > - None + 0 ```{autodoc2-docstring} bumpversion.scm.SCMInfo.distance_to_latest_tag +:parser: myst ``` ```` @@ -115,6 +127,7 @@ None ```{autodoc2-docstring} bumpversion.scm.SCMInfo.current_version +:parser: myst ``` ```` @@ -126,6 +139,7 @@ None ```{autodoc2-docstring} bumpversion.scm.SCMInfo.branch_name +:parser: myst ``` ```` @@ -137,6 +151,7 @@ None ```{autodoc2-docstring} bumpversion.scm.SCMInfo.short_branch_name +:parser: myst ``` ```` @@ -148,6 +163,7 @@ None ```{autodoc2-docstring} bumpversion.scm.SCMInfo.dirty +:parser: myst ``` ```` @@ -168,6 +184,7 @@ :canonical: bumpversion.scm.SourceCodeManager ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager +:parser: myst ``` ````{py:attribute} _TEST_USABLE_COMMAND @@ -177,6 +194,7 @@ [] ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager._TEST_USABLE_COMMAND +:parser: myst ``` ```` @@ -188,6 +206,7 @@ [] ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager._COMMIT_COMMAND +:parser: myst ``` ```` @@ -199,6 +218,7 @@ [] ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager._ALL_TAGS_COMMAND +:parser: myst ``` ```` @@ -208,6 +228,7 @@ :classmethod: ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager.commit +:parser: myst ``` ```` @@ -217,6 +238,7 @@ :classmethod: ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager.is_usable +:parser: myst ``` ```` @@ -227,6 +249,7 @@ :classmethod: ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager.assert_nondirty +:parser: myst ``` ```` @@ -237,6 +260,7 @@ :classmethod: ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager.latest_tag_info +:parser: myst ``` ```` @@ -247,6 +271,7 @@ :classmethod: ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager.add_path +:parser: myst ``` ```` @@ -257,6 +282,7 @@ :classmethod: ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager.tag +:parser: myst ``` ```` @@ -266,6 +292,7 @@ :classmethod: ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager.get_all_tags +:parser: myst ``` ```` @@ -275,6 +302,7 @@ :classmethod: ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager.get_version_from_tag +:parser: myst ``` ```` @@ -284,6 +312,7 @@ :classmethod: ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager.commit_to_scm +:parser: myst ``` ```` @@ -293,6 +322,7 @@ :classmethod: ```{autodoc2-docstring} bumpversion.scm.SourceCodeManager.tag_in_scm +:parser: myst ``` ```` @@ -315,6 +345,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` ```{autodoc2-docstring} bumpversion.scm.Git +:parser: myst ``` ````{py:attribute} _TEST_USABLE_COMMAND @@ -324,6 +355,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` ['git', 'rev-parse', '--git-dir'] ```{autodoc2-docstring} bumpversion.scm.Git._TEST_USABLE_COMMAND +:parser: myst ``` ```` @@ -335,6 +367,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` ['git', 'commit', '-F'] ```{autodoc2-docstring} bumpversion.scm.Git._COMMIT_COMMAND +:parser: myst ``` ```` @@ -346,6 +379,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` ['git', 'tag', '--list'] ```{autodoc2-docstring} bumpversion.scm.Git._ALL_TAGS_COMMAND +:parser: myst ``` ```` @@ -355,6 +389,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` :classmethod: ```{autodoc2-docstring} bumpversion.scm.Git.assert_nondirty +:parser: myst ``` ```` @@ -364,6 +399,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` :classmethod: ```{autodoc2-docstring} bumpversion.scm.Git.latest_tag_info +:parser: myst ``` ```` @@ -373,6 +409,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` :classmethod: ```{autodoc2-docstring} bumpversion.scm.Git.add_path +:parser: myst ``` ```` @@ -382,6 +419,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` :classmethod: ```{autodoc2-docstring} bumpversion.scm.Git.tag +:parser: myst ``` ```` @@ -394,6 +432,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` Bases: {py:obj}`bumpversion.scm.SourceCodeManager` ```{autodoc2-docstring} bumpversion.scm.Mercurial +:parser: myst ``` ````{py:attribute} _TEST_USABLE_COMMAND @@ -403,6 +442,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` ['hg', 'root'] ```{autodoc2-docstring} bumpversion.scm.Mercurial._TEST_USABLE_COMMAND +:parser: myst ``` ```` @@ -414,6 +454,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` ['hg', 'commit', '--logfile'] ```{autodoc2-docstring} bumpversion.scm.Mercurial._COMMIT_COMMAND +:parser: myst ``` ```` @@ -425,6 +466,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` ['hg', 'log', '--rev="tag()"', '--template="{tags}\n"'] ```{autodoc2-docstring} bumpversion.scm.Mercurial._ALL_TAGS_COMMAND +:parser: myst ``` ```` @@ -434,6 +476,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` :classmethod: ```{autodoc2-docstring} bumpversion.scm.Mercurial.latest_tag_info +:parser: myst ``` ```` @@ -443,6 +486,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` :classmethod: ```{autodoc2-docstring} bumpversion.scm.Mercurial.assert_nondirty +:parser: myst ``` ```` @@ -452,6 +496,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` :classmethod: ```{autodoc2-docstring} bumpversion.scm.Mercurial.add_path +:parser: myst ``` ```` @@ -461,6 +506,7 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` :classmethod: ```{autodoc2-docstring} bumpversion.scm.Mercurial.tag +:parser: myst ``` ```` @@ -471,5 +517,6 @@ Bases: {py:obj}`bumpversion.scm.SourceCodeManager` :canonical: bumpversion.scm.get_scm_info ```{autodoc2-docstring} bumpversion.scm.get_scm_info +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.show.md b/docsrc/reference/bumpversion/bumpversion.show.md index cb72424b..c10101d6 100644 --- a/docsrc/reference/bumpversion/bumpversion.show.md +++ b/docsrc/reference/bumpversion/bumpversion.show.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.show +:parser: myst :allowtitles: ``` @@ -17,26 +18,32 @@ * - {py:obj}`output_default ` - ```{autodoc2-docstring} bumpversion.show.output_default + :parser: myst :summary: ``` * - {py:obj}`output_yaml ` - ```{autodoc2-docstring} bumpversion.show.output_yaml + :parser: myst :summary: ``` * - {py:obj}`output_json ` - ```{autodoc2-docstring} bumpversion.show.output_json + :parser: myst :summary: ``` * - {py:obj}`resolve_name ` - ```{autodoc2-docstring} bumpversion.show.resolve_name + :parser: myst :summary: ``` * - {py:obj}`log_list ` - ```{autodoc2-docstring} bumpversion.show.log_list + :parser: myst :summary: ``` * - {py:obj}`do_show ` - ```{autodoc2-docstring} bumpversion.show.do_show + :parser: myst :summary: ``` ```` @@ -49,6 +56,7 @@ * - {py:obj}`OUTPUTTERS ` - ```{autodoc2-docstring} bumpversion.show.OUTPUTTERS + :parser: myst :summary: ``` ```` @@ -59,6 +67,7 @@ :canonical: bumpversion.show.output_default ```{autodoc2-docstring} bumpversion.show.output_default +:parser: myst ``` ```` @@ -66,6 +75,7 @@ :canonical: bumpversion.show.output_yaml ```{autodoc2-docstring} bumpversion.show.output_yaml +:parser: myst ``` ```` @@ -73,6 +83,7 @@ :canonical: bumpversion.show.output_json ```{autodoc2-docstring} bumpversion.show.output_json +:parser: myst ``` ```` @@ -82,6 +93,7 @@ None ```{autodoc2-docstring} bumpversion.show.OUTPUTTERS +:parser: myst ``` ```` @@ -90,6 +102,7 @@ :canonical: bumpversion.show.resolve_name ```{autodoc2-docstring} bumpversion.show.resolve_name +:parser: myst ``` ```` @@ -97,6 +110,7 @@ :canonical: bumpversion.show.log_list ```{autodoc2-docstring} bumpversion.show.log_list +:parser: myst ``` ```` @@ -104,5 +118,6 @@ :canonical: bumpversion.show.do_show ```{autodoc2-docstring} bumpversion.show.do_show +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.ui.md b/docsrc/reference/bumpversion/bumpversion.ui.md index 85ed5321..eb6a991d 100644 --- a/docsrc/reference/bumpversion/bumpversion.ui.md +++ b/docsrc/reference/bumpversion/bumpversion.ui.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.ui +:parser: myst :allowtitles: ``` @@ -17,22 +18,27 @@ * - {py:obj}`get_indented_logger ` - ```{autodoc2-docstring} bumpversion.ui.get_indented_logger + :parser: myst :summary: ``` * - {py:obj}`setup_logging ` - ```{autodoc2-docstring} bumpversion.ui.setup_logging + :parser: myst :summary: ``` * - {py:obj}`print_info ` - ```{autodoc2-docstring} bumpversion.ui.print_info + :parser: myst :summary: ``` * - {py:obj}`print_error ` - ```{autodoc2-docstring} bumpversion.ui.print_error + :parser: myst :summary: ``` * - {py:obj}`print_warning ` - ```{autodoc2-docstring} bumpversion.ui.print_warning + :parser: myst :summary: ``` ```` @@ -45,10 +51,12 @@ * - {py:obj}`logger ` - ```{autodoc2-docstring} bumpversion.ui.logger + :parser: myst :summary: ``` * - {py:obj}`VERBOSITY ` - ```{autodoc2-docstring} bumpversion.ui.VERBOSITY + :parser: myst :summary: ``` ```` @@ -61,6 +69,7 @@ 'getLogger(...)' ```{autodoc2-docstring} bumpversion.ui.logger +:parser: myst ``` ```` @@ -71,6 +80,7 @@ None ```{autodoc2-docstring} bumpversion.ui.VERBOSITY +:parser: myst ``` ```` @@ -79,6 +89,7 @@ :canonical: bumpversion.ui.get_indented_logger ```{autodoc2-docstring} bumpversion.ui.get_indented_logger +:parser: myst ``` ```` @@ -86,6 +97,7 @@ :canonical: bumpversion.ui.setup_logging ```{autodoc2-docstring} bumpversion.ui.setup_logging +:parser: myst ``` ```` @@ -93,6 +105,7 @@ :canonical: bumpversion.ui.print_info ```{autodoc2-docstring} bumpversion.ui.print_info +:parser: myst ``` ```` @@ -100,6 +113,7 @@ :canonical: bumpversion.ui.print_error ```{autodoc2-docstring} bumpversion.ui.print_error +:parser: myst ``` ```` @@ -107,5 +121,6 @@ :canonical: bumpversion.ui.print_warning ```{autodoc2-docstring} bumpversion.ui.print_warning +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.utils.md b/docsrc/reference/bumpversion/bumpversion.utils.md index 56aa7389..f8d94a3f 100644 --- a/docsrc/reference/bumpversion/bumpversion.utils.md +++ b/docsrc/reference/bumpversion/bumpversion.utils.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.utils +:parser: myst :allowtitles: ``` @@ -17,38 +18,52 @@ * - {py:obj}`extract_regex_flags ` - ```{autodoc2-docstring} bumpversion.utils.extract_regex_flags + :parser: myst :summary: ``` * - {py:obj}`recursive_sort_dict ` - ```{autodoc2-docstring} bumpversion.utils.recursive_sort_dict + :parser: myst :summary: ``` * - {py:obj}`key_val_string ` - ```{autodoc2-docstring} bumpversion.utils.key_val_string + :parser: myst :summary: ``` * - {py:obj}`prefixed_environ ` - ```{autodoc2-docstring} bumpversion.utils.prefixed_environ + :parser: myst :summary: ``` * - {py:obj}`labels_for_format ` - ```{autodoc2-docstring} bumpversion.utils.labels_for_format + :parser: myst + :summary: + ``` +* - {py:obj}`base_context ` + - ```{autodoc2-docstring} bumpversion.utils.base_context + :parser: myst :summary: ``` * - {py:obj}`get_context ` - ```{autodoc2-docstring} bumpversion.utils.get_context + :parser: myst :summary: ``` * - {py:obj}`get_overrides ` - ```{autodoc2-docstring} bumpversion.utils.get_overrides + :parser: myst :summary: ``` * - {py:obj}`get_nested_value ` - ```{autodoc2-docstring} bumpversion.utils.get_nested_value + :parser: myst :summary: ``` * - {py:obj}`set_nested_value ` - ```{autodoc2-docstring} bumpversion.utils.set_nested_value + :parser: myst :summary: ``` ```` @@ -59,6 +74,7 @@ :canonical: bumpversion.utils.extract_regex_flags ```{autodoc2-docstring} bumpversion.utils.extract_regex_flags +:parser: myst ``` ```` @@ -66,6 +82,7 @@ :canonical: bumpversion.utils.recursive_sort_dict ```{autodoc2-docstring} bumpversion.utils.recursive_sort_dict +:parser: myst ``` ```` @@ -73,6 +90,7 @@ :canonical: bumpversion.utils.key_val_string ```{autodoc2-docstring} bumpversion.utils.key_val_string +:parser: myst ``` ```` @@ -80,6 +98,7 @@ :canonical: bumpversion.utils.prefixed_environ ```{autodoc2-docstring} bumpversion.utils.prefixed_environ +:parser: myst ``` ```` @@ -87,13 +106,23 @@ :canonical: bumpversion.utils.labels_for_format ```{autodoc2-docstring} bumpversion.utils.labels_for_format +:parser: myst +``` +```` + +````{py:function} base_context(scm_info: typing.Optional[bumpversion.scm.SCMInfo] = None) -> collections.ChainMap +:canonical: bumpversion.utils.base_context + +```{autodoc2-docstring} bumpversion.utils.base_context +:parser: myst ``` ```` -````{py:function} get_context(config: bumpversion.config.Config, current_version: typing.Optional[bumpversion.version_part.Version] = None, new_version: typing.Optional[bumpversion.version_part.Version] = None) -> collections.ChainMap +````{py:function} get_context(config: bumpversion.config.Config, current_version: typing.Optional[bumpversion.versioning.models.Version] = None, new_version: typing.Optional[bumpversion.versioning.models.Version] = None) -> collections.ChainMap :canonical: bumpversion.utils.get_context ```{autodoc2-docstring} bumpversion.utils.get_context +:parser: myst ``` ```` @@ -101,6 +130,7 @@ :canonical: bumpversion.utils.get_overrides ```{autodoc2-docstring} bumpversion.utils.get_overrides +:parser: myst ``` ```` @@ -108,6 +138,7 @@ :canonical: bumpversion.utils.get_nested_value ```{autodoc2-docstring} bumpversion.utils.get_nested_value +:parser: myst ``` ```` @@ -115,5 +146,6 @@ :canonical: bumpversion.utils.set_nested_value ```{autodoc2-docstring} bumpversion.utils.set_nested_value +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.version_part.md b/docsrc/reference/bumpversion/bumpversion.version_part.md index 4bb79466..c20cf510 100644 --- a/docsrc/reference/bumpversion/bumpversion.version_part.md +++ b/docsrc/reference/bumpversion/bumpversion.version_part.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.version_part +:parser: myst :allowtitles: ``` @@ -15,16 +16,9 @@ :class: autosummary longtable :align: left -* - {py:obj}`VersionPart ` - - ```{autodoc2-docstring} bumpversion.version_part.VersionPart - :summary: - ``` -* - {py:obj}`Version ` - - ```{autodoc2-docstring} bumpversion.version_part.Version - :summary: - ``` * - {py:obj}`VersionConfig ` - ```{autodoc2-docstring} bumpversion.version_part.VersionConfig + :parser: myst :summary: ``` ```` @@ -37,6 +31,7 @@ * - {py:obj}`logger ` - ```{autodoc2-docstring} bumpversion.version_part.logger + :parser: myst :summary: ``` ```` @@ -49,156 +44,23 @@ 'get_indented_logger(...)' ```{autodoc2-docstring} bumpversion.version_part.logger +:parser: myst ``` ```` -`````{py:class} VersionPart(config: bumpversion.config.models.VersionPartConfig, value: typing.Union[str, int, None] = None) -:canonical: bumpversion.version_part.VersionPart - -```{autodoc2-docstring} bumpversion.version_part.VersionPart -``` - -```{rubric} Initialization -``` - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.__init__ -``` - -````{py:property} value -:canonical: bumpversion.version_part.VersionPart.value -:type: str - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.value -``` - -```` - -````{py:method} copy() -> bumpversion.version_part.VersionPart -:canonical: bumpversion.version_part.VersionPart.copy - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.copy -``` - -```` - -````{py:method} bump() -> bumpversion.version_part.VersionPart -:canonical: bumpversion.version_part.VersionPart.bump - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.bump -``` - -```` - -````{py:method} null() -> bumpversion.version_part.VersionPart -:canonical: bumpversion.version_part.VersionPart.null - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.null -``` - -```` - -````{py:property} is_optional -:canonical: bumpversion.version_part.VersionPart.is_optional -:type: bool - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.is_optional -``` - -```` - -````{py:property} is_independent -:canonical: bumpversion.version_part.VersionPart.is_independent -:type: bool - -```{autodoc2-docstring} bumpversion.version_part.VersionPart.is_independent -``` - -```` - -````{py:method} __format__(format_spec: str) -> str -:canonical: bumpversion.version_part.VersionPart.__format__ - -```` - -````{py:method} __repr__() -> str -:canonical: bumpversion.version_part.VersionPart.__repr__ - -```` - -````{py:method} __eq__(other: typing.Any) -> bool -:canonical: bumpversion.version_part.VersionPart.__eq__ - -```` - -````` - -`````{py:class} Version(values: typing.Dict[str, bumpversion.version_part.VersionPart], original: typing.Optional[str] = None) -:canonical: bumpversion.version_part.Version - -```{autodoc2-docstring} bumpversion.version_part.Version -``` - -```{rubric} Initialization -``` - -```{autodoc2-docstring} bumpversion.version_part.Version.__init__ -``` - -````{py:method} __getitem__(key: str) -> bumpversion.version_part.VersionPart -:canonical: bumpversion.version_part.Version.__getitem__ - -```{autodoc2-docstring} bumpversion.version_part.Version.__getitem__ -``` - -```` - -````{py:method} __len__() -> int -:canonical: bumpversion.version_part.Version.__len__ - -```{autodoc2-docstring} bumpversion.version_part.Version.__len__ -``` - -```` - -````{py:method} __iter__() -:canonical: bumpversion.version_part.Version.__iter__ - -```{autodoc2-docstring} bumpversion.version_part.Version.__iter__ -``` - -```` - -````{py:method} __repr__() -:canonical: bumpversion.version_part.Version.__repr__ - -```` - -````{py:method} __eq__(other: typing.Any) -> bool -:canonical: bumpversion.version_part.Version.__eq__ - -```` - -````{py:method} bump(part_name: str, order: typing.List[str]) -> bumpversion.version_part.Version -:canonical: bumpversion.version_part.Version.bump - -```{autodoc2-docstring} bumpversion.version_part.Version.bump -``` - -```` - -````` - -`````{py:class} VersionConfig(parse: str, serialize: typing.Tuple[str], search: str, replace: str, part_configs: typing.Optional[typing.Dict[str, bumpversion.config.models.VersionPartConfig]] = None) +`````{py:class} VersionConfig(parse: str, serialize: typing.Tuple[str], search: str, replace: str, part_configs: typing.Optional[typing.Dict[str, bumpversion.versioning.models.VersionComponentSpec]] = None) :canonical: bumpversion.version_part.VersionConfig ```{autodoc2-docstring} bumpversion.version_part.VersionConfig +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.version_part.VersionConfig.__init__ +:parser: myst ``` ````{py:method} __repr__() -> str @@ -216,38 +78,25 @@ :type: typing.List[str] ```{autodoc2-docstring} bumpversion.version_part.VersionConfig.order +:parser: myst ``` ```` -````{py:method} parse(version_string: typing.Optional[str] = None) -> typing.Optional[bumpversion.version_part.Version] +````{py:method} parse(version_string: typing.Optional[str] = None) -> typing.Optional[bumpversion.versioning.models.Version] :canonical: bumpversion.version_part.VersionConfig.parse ```{autodoc2-docstring} bumpversion.version_part.VersionConfig.parse +:parser: myst ``` ```` -````{py:method} _serialize(version: bumpversion.version_part.Version, serialize_format: str, context: typing.MutableMapping, raise_if_incomplete: bool = False) -> str -:canonical: bumpversion.version_part.VersionConfig._serialize - -```{autodoc2-docstring} bumpversion.version_part.VersionConfig._serialize -``` - -```` - -````{py:method} _choose_serialize_format(version: bumpversion.version_part.Version, context: typing.MutableMapping) -> str -:canonical: bumpversion.version_part.VersionConfig._choose_serialize_format - -```{autodoc2-docstring} bumpversion.version_part.VersionConfig._choose_serialize_format -``` - -```` - -````{py:method} serialize(version: bumpversion.version_part.Version, context: typing.MutableMapping) -> str +````{py:method} serialize(version: bumpversion.versioning.models.Version, context: typing.MutableMapping) -> str :canonical: bumpversion.version_part.VersionConfig.serialize ```{autodoc2-docstring} bumpversion.version_part.VersionConfig.serialize +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.visualize.md b/docsrc/reference/bumpversion/bumpversion.visualize.md index e5b4bd71..20963908 100644 --- a/docsrc/reference/bumpversion/bumpversion.visualize.md +++ b/docsrc/reference/bumpversion/bumpversion.visualize.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.visualize +:parser: myst :allowtitles: ``` @@ -17,6 +18,7 @@ * - {py:obj}`Border ` - ```{autodoc2-docstring} bumpversion.visualize.Border + :parser: myst :summary: ``` ```` @@ -29,18 +31,27 @@ * - {py:obj}`lead_string ` - ```{autodoc2-docstring} bumpversion.visualize.lead_string + :parser: myst :summary: ``` * - {py:obj}`connection_str ` - ```{autodoc2-docstring} bumpversion.visualize.connection_str + :parser: myst :summary: ``` * - {py:obj}`labeled_line ` - ```{autodoc2-docstring} bumpversion.visualize.labeled_line + :parser: myst + :summary: + ``` +* - {py:obj}`filter_version_parts ` + - ```{autodoc2-docstring} bumpversion.visualize.filter_version_parts + :parser: myst :summary: ``` * - {py:obj}`visualize ` - ```{autodoc2-docstring} bumpversion.visualize.visualize + :parser: myst :summary: ``` ```` @@ -53,6 +64,7 @@ * - {py:obj}`BOX_CHARS ` - ```{autodoc2-docstring} bumpversion.visualize.BOX_CHARS + :parser: myst :summary: ``` ```` @@ -65,6 +77,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.BOX_CHARS +:parser: myst ``` ```` @@ -73,6 +86,7 @@ :canonical: bumpversion.visualize.Border ```{autodoc2-docstring} bumpversion.visualize.Border +:parser: myst ``` ````{py:attribute} corner_bottom_right @@ -82,6 +96,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.corner_bottom_right +:parser: myst ``` ```` @@ -93,6 +108,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.corner_top_right +:parser: myst ``` ```` @@ -104,6 +120,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.corner_top_left +:parser: myst ``` ```` @@ -115,6 +132,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.corner_bottom_left +:parser: myst ``` ```` @@ -126,6 +144,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.divider_left +:parser: myst ``` ```` @@ -137,6 +156,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.divider_up +:parser: myst ``` ```` @@ -148,6 +168,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.divider_down +:parser: myst ``` ```` @@ -159,6 +180,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.divider_right +:parser: myst ``` ```` @@ -170,6 +192,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.line +:parser: myst ``` ```` @@ -181,6 +204,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.pipe +:parser: myst ``` ```` @@ -192,6 +216,7 @@ None ```{autodoc2-docstring} bumpversion.visualize.Border.cross +:parser: myst ``` ```` @@ -202,6 +227,7 @@ :canonical: bumpversion.visualize.lead_string ```{autodoc2-docstring} bumpversion.visualize.lead_string +:parser: myst ``` ```` @@ -209,6 +235,7 @@ :canonical: bumpversion.visualize.connection_str ```{autodoc2-docstring} bumpversion.visualize.connection_str +:parser: myst ``` ```` @@ -216,6 +243,15 @@ :canonical: bumpversion.visualize.labeled_line ```{autodoc2-docstring} bumpversion.visualize.labeled_line +:parser: myst +``` +```` + +````{py:function} filter_version_parts(config: bumpversion.config.Config) -> typing.List[str] +:canonical: bumpversion.visualize.filter_version_parts + +```{autodoc2-docstring} bumpversion.visualize.filter_version_parts +:parser: myst ``` ```` @@ -223,5 +259,6 @@ :canonical: bumpversion.visualize.visualize ```{autodoc2-docstring} bumpversion.visualize.visualize +:parser: myst ``` ```` diff --git a/docsrc/reference/bumpversion/bumpversion.yaml_dump.md b/docsrc/reference/bumpversion/bumpversion.yaml_dump.md index 68b4eb8f..034426da 100644 --- a/docsrc/reference/bumpversion/bumpversion.yaml_dump.md +++ b/docsrc/reference/bumpversion/bumpversion.yaml_dump.md @@ -4,6 +4,7 @@ ``` ```{autodoc2-docstring} bumpversion.yaml_dump +:parser: myst :allowtitles: ``` @@ -17,6 +18,7 @@ * - {py:obj}`YAMLDumpers ` - ```{autodoc2-docstring} bumpversion.yaml_dump.YAMLDumpers + :parser: myst :summary: ``` ```` @@ -29,42 +31,52 @@ * - {py:obj}`dump ` - ```{autodoc2-docstring} bumpversion.yaml_dump.dump + :parser: myst :summary: ``` * - {py:obj}`format_str ` - ```{autodoc2-docstring} bumpversion.yaml_dump.format_str + :parser: myst :summary: ``` * - {py:obj}`format_int ` - ```{autodoc2-docstring} bumpversion.yaml_dump.format_int + :parser: myst :summary: ``` * - {py:obj}`format_float ` - ```{autodoc2-docstring} bumpversion.yaml_dump.format_float + :parser: myst :summary: ``` * - {py:obj}`format_bool ` - ```{autodoc2-docstring} bumpversion.yaml_dump.format_bool + :parser: myst :summary: ``` * - {py:obj}`format_dict ` - ```{autodoc2-docstring} bumpversion.yaml_dump.format_dict + :parser: myst :summary: ``` * - {py:obj}`format_sequence ` - ```{autodoc2-docstring} bumpversion.yaml_dump.format_sequence + :parser: myst :summary: ``` * - {py:obj}`format_none ` - ```{autodoc2-docstring} bumpversion.yaml_dump.format_none + :parser: myst :summary: ``` * - {py:obj}`format_date ` - ```{autodoc2-docstring} bumpversion.yaml_dump.format_date + :parser: myst :summary: ``` * - {py:obj}`format_datetime ` - ```{autodoc2-docstring} bumpversion.yaml_dump.format_datetime + :parser: myst :summary: ``` ```` @@ -77,14 +89,17 @@ * - {py:obj}`DumperFunc ` - ```{autodoc2-docstring} bumpversion.yaml_dump.DumperFunc + :parser: myst :summary: ``` * - {py:obj}`YAML_DUMPERS ` - ```{autodoc2-docstring} bumpversion.yaml_dump.YAML_DUMPERS + :parser: myst :summary: ``` * - {py:obj}`INDENT ` - ```{autodoc2-docstring} bumpversion.yaml_dump.INDENT + :parser: myst :summary: ``` ```` @@ -97,6 +112,7 @@ None ```{autodoc2-docstring} bumpversion.yaml_dump.DumperFunc +:parser: myst ``` ```` @@ -107,18 +123,21 @@ Bases: {py:obj}`collections.UserDict` ```{autodoc2-docstring} bumpversion.yaml_dump.YAMLDumpers +:parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} bumpversion.yaml_dump.YAMLDumpers.__init__ +:parser: myst ``` ````{py:method} add_dumper(data_type: type, dumper: bumpversion.yaml_dump.DumperFunc) -> None :canonical: bumpversion.yaml_dump.YAMLDumpers.add_dumper ```{autodoc2-docstring} bumpversion.yaml_dump.YAMLDumpers.add_dumper +:parser: myst ``` ```` @@ -131,6 +150,7 @@ Bases: {py:obj}`collections.UserDict` 'YAMLDumpers(...)' ```{autodoc2-docstring} bumpversion.yaml_dump.YAML_DUMPERS +:parser: myst ``` ```` @@ -141,6 +161,7 @@ Bases: {py:obj}`collections.UserDict` ' ' ```{autodoc2-docstring} bumpversion.yaml_dump.INDENT +:parser: myst ``` ```` @@ -149,6 +170,7 @@ Bases: {py:obj}`collections.UserDict` :canonical: bumpversion.yaml_dump.dump ```{autodoc2-docstring} bumpversion.yaml_dump.dump +:parser: myst ``` ```` @@ -156,6 +178,7 @@ Bases: {py:obj}`collections.UserDict` :canonical: bumpversion.yaml_dump.format_str ```{autodoc2-docstring} bumpversion.yaml_dump.format_str +:parser: myst ``` ```` @@ -163,6 +186,7 @@ Bases: {py:obj}`collections.UserDict` :canonical: bumpversion.yaml_dump.format_int ```{autodoc2-docstring} bumpversion.yaml_dump.format_int +:parser: myst ``` ```` @@ -170,6 +194,7 @@ Bases: {py:obj}`collections.UserDict` :canonical: bumpversion.yaml_dump.format_float ```{autodoc2-docstring} bumpversion.yaml_dump.format_float +:parser: myst ``` ```` @@ -177,6 +202,7 @@ Bases: {py:obj}`collections.UserDict` :canonical: bumpversion.yaml_dump.format_bool ```{autodoc2-docstring} bumpversion.yaml_dump.format_bool +:parser: myst ``` ```` @@ -184,6 +210,7 @@ Bases: {py:obj}`collections.UserDict` :canonical: bumpversion.yaml_dump.format_dict ```{autodoc2-docstring} bumpversion.yaml_dump.format_dict +:parser: myst ``` ```` @@ -191,6 +218,7 @@ Bases: {py:obj}`collections.UserDict` :canonical: bumpversion.yaml_dump.format_sequence ```{autodoc2-docstring} bumpversion.yaml_dump.format_sequence +:parser: myst ``` ```` @@ -198,6 +226,7 @@ Bases: {py:obj}`collections.UserDict` :canonical: bumpversion.yaml_dump.format_none ```{autodoc2-docstring} bumpversion.yaml_dump.format_none +:parser: myst ``` ```` @@ -205,6 +234,7 @@ Bases: {py:obj}`collections.UserDict` :canonical: bumpversion.yaml_dump.format_date ```{autodoc2-docstring} bumpversion.yaml_dump.format_date +:parser: myst ``` ```` @@ -212,5 +242,6 @@ Bases: {py:obj}`collections.UserDict` :canonical: bumpversion.yaml_dump.format_datetime ```{autodoc2-docstring} bumpversion.yaml_dump.format_datetime +:parser: myst ``` ```` diff --git a/docsrc/reference/cli.rst b/docsrc/reference/cli.rst index cc17c60b..eadf1706 100644 --- a/docsrc/reference/cli.rst +++ b/docsrc/reference/cli.rst @@ -2,5 +2,5 @@ Command-line Interface ====================== .. click:: bumpversion.cli:cli - :prog: bumpversion + :prog: bump-my-version :nested: full