Added mental model documentation

callowayproject · Jan 29, 2024 · 5cbd250 · 5cbd250
1 parent b538308
commit 5cbd250
Show file tree

Hide file tree

Showing 17 changed files with 3,899 additions and 0 deletions.
diff --git a/docsrc/_static/creating-a-version-spec.png b/docsrc/_static/creating-a-version-spec.png
diff --git a/docsrc/_static/creating-a-version-spec.svg b/docsrc/_static/creating-a-version-spec.svg
diff --git a/docsrc/_static/creating-a-version.png b/docsrc/_static/creating-a-version.png
diff --git a/docsrc/_static/creating-a-version.svg b/docsrc/_static/creating-a-version.svg
diff --git a/docsrc/_static/serializing-a-version-1-0-0.png b/docsrc/_static/serializing-a-version-1-0-0.png
diff --git a/docsrc/_static/serializing-a-version-1-0-0.svg b/docsrc/_static/serializing-a-version-1-0-0.svg
diff --git a/docsrc/_static/serializing-a-version-1-2-0.png b/docsrc/_static/serializing-a-version-1-2-0.png
diff --git a/docsrc/_static/serializing-a-version-1-2-0.svg b/docsrc/_static/serializing-a-version-1-2-0.svg
diff --git a/docsrc/_static/serializing-a-version-1-2-3.png b/docsrc/_static/serializing-a-version-1-2-3.png
diff --git a/docsrc/_static/serializing-a-version-1-2-3.svg b/docsrc/_static/serializing-a-version-1-2-3.svg
diff --git a/docsrc/_static/serializing-a-version-1.svg b/docsrc/_static/serializing-a-version-1.svg
diff --git a/docsrc/bump-my-version-model.drawio b/docsrc/bump-my-version-model.drawio
diff --git a/docsrc/reference/bumpversion/bumpversion.versioning.conventions.md b/docsrc/reference/bumpversion/bumpversion.versioning.conventions.md
@@ -0,0 +1,149 @@
+# {py:mod}`bumpversion.versioning.conventions`
+
+```{py:module} bumpversion.versioning.conventions
+```
+
+```{autodoc2-docstring} bumpversion.versioning.conventions
+:parser: myst
+:allowtitles:
+```
+
+## Module Contents
+
+### Functions
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`pep440_version_spec <bumpversion.versioning.conventions.pep440_version_spec>`
+  - ```{autodoc2-docstring} bumpversion.versioning.conventions.pep440_version_spec
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`semver_spec <bumpversion.versioning.conventions.semver_spec>`
+  - ```{autodoc2-docstring} bumpversion.versioning.conventions.semver_spec
+    :parser: myst
+    :summary:
+    ```
+````
+
+### Data
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`PEP440_PATTERN <bumpversion.versioning.conventions.PEP440_PATTERN>`
+  - ```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_PATTERN
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`PEP440_SERIALIZE_PATTERNS <bumpversion.versioning.conventions.PEP440_SERIALIZE_PATTERNS>`
+  - ```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_SERIALIZE_PATTERNS
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`PEP440_COMPONENT_CONFIGS <bumpversion.versioning.conventions.PEP440_COMPONENT_CONFIGS>`
+  - ```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_COMPONENT_CONFIGS
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`SEMVER_PATTERN <bumpversion.versioning.conventions.SEMVER_PATTERN>`
+  - ```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_PATTERN
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`SEMVER_SERIALIZE_PATTERNS <bumpversion.versioning.conventions.SEMVER_SERIALIZE_PATTERNS>`
+  - ```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_SERIALIZE_PATTERNS
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`SEMVER_COMPONENT_CONFIGS <bumpversion.versioning.conventions.SEMVER_COMPONENT_CONFIGS>`
+  - ```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_COMPONENT_CONFIGS
+    :parser: myst
+    :summary:
+    ```
+````
+
+### API
+
+````{py:data} PEP440_PATTERN
+:canonical: bumpversion.versioning.conventions.PEP440_PATTERN
+:value: <Multiline-String>
+
+```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_PATTERN
+:parser: myst
+```
+
+````
+
+````{py:data} PEP440_SERIALIZE_PATTERNS
+:canonical: bumpversion.versioning.conventions.PEP440_SERIALIZE_PATTERNS
+:value: >
+   ['{major}.{minor}.{patch}{pre_l}{pre_n}.{post}.{dev}+{local}', '{major}.{minor}.{patch}{pre_l}{pre_n...
+
+```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_SERIALIZE_PATTERNS
+:parser: myst
+```
+
+````
+
+````{py:data} PEP440_COMPONENT_CONFIGS
+:canonical: bumpversion.versioning.conventions.PEP440_COMPONENT_CONFIGS
+:value: >
+   None
+
+```{autodoc2-docstring} bumpversion.versioning.conventions.PEP440_COMPONENT_CONFIGS
+:parser: myst
+```
+
+````
+
+````{py:function} pep440_version_spec() -> bumpversion.versioning.models.VersionSpec
+:canonical: bumpversion.versioning.conventions.pep440_version_spec
+
+```{autodoc2-docstring} bumpversion.versioning.conventions.pep440_version_spec
+:parser: myst
+```
+````
+
+````{py:data} SEMVER_PATTERN
+:canonical: bumpversion.versioning.conventions.SEMVER_PATTERN
+:value: <Multiline-String>
+
+```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_PATTERN
+:parser: myst
+```
+
+````
+
+````{py:data} SEMVER_SERIALIZE_PATTERNS
+:canonical: bumpversion.versioning.conventions.SEMVER_SERIALIZE_PATTERNS
+:value: >
+   ['{major}.{minor}.{patch}-{pre_l}{pre_n}+{buildmetadata}', '{major}.{minor}.{patch}-{pre_l}{pre_n}',...
+
+```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_SERIALIZE_PATTERNS
+:parser: myst
+```
+
+````
+
+````{py:data} SEMVER_COMPONENT_CONFIGS
+:canonical: bumpversion.versioning.conventions.SEMVER_COMPONENT_CONFIGS
+:value: >
+   None
+
+```{autodoc2-docstring} bumpversion.versioning.conventions.SEMVER_COMPONENT_CONFIGS
+:parser: myst
+```
+
+````
+
+````{py:function} semver_spec() -> bumpversion.versioning.models.VersionSpec
+:canonical: bumpversion.versioning.conventions.semver_spec
+
+```{autodoc2-docstring} bumpversion.versioning.conventions.semver_spec
+:parser: myst
+```
+````
diff --git a/docsrc/reference/bumpversion/bumpversion.versioning.functions.md b/docsrc/reference/bumpversion/bumpversion.versioning.functions.md
@@ -0,0 +1,188 @@
+# {py:mod}`bumpversion.versioning.functions`
+
+```{py:module} bumpversion.versioning.functions
+```
+
+```{autodoc2-docstring} bumpversion.versioning.functions
+:parser: myst
+:allowtitles:
+```
+
+## Module Contents
+
+### Classes
+
+````{list-table}
+:class: autosummary longtable
+:align: left
+
+* - {py:obj}`PartFunction <bumpversion.versioning.functions.PartFunction>`
+  - ```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`IndependentFunction <bumpversion.versioning.functions.IndependentFunction>`
+  - ```{autodoc2-docstring} bumpversion.versioning.functions.IndependentFunction
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`NumericFunction <bumpversion.versioning.functions.NumericFunction>`
+  - ```{autodoc2-docstring} bumpversion.versioning.functions.NumericFunction
+    :parser: myst
+    :summary:
+    ```
+* - {py:obj}`ValuesFunction <bumpversion.versioning.functions.ValuesFunction>`
+  - ```{autodoc2-docstring} bumpversion.versioning.functions.ValuesFunction
+    :parser: myst
+    :summary:
+    ```
+````
+
+### API
+
+`````{py:class} PartFunction
+:canonical: bumpversion.versioning.functions.PartFunction
+
+```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction
+:parser: myst
+```
+
+````{py:attribute} first_value
+:canonical: bumpversion.versioning.functions.PartFunction.first_value
+:type: str
+:value: >
+   None
+
+```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction.first_value
+:parser: myst
+```
+
+````
+
+````{py:attribute} optional_value
+:canonical: bumpversion.versioning.functions.PartFunction.optional_value
+:type: str
+:value: >
+   None
+
+```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction.optional_value
+:parser: myst
+```
+
+````
+
+````{py:attribute} independent
+:canonical: bumpversion.versioning.functions.PartFunction.independent
+:type: bool
+:value: >
+   None
+
+```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction.independent
+:parser: myst
+```
+
+````
+
+````{py:method} bump(value: str) -> str
+:canonical: bumpversion.versioning.functions.PartFunction.bump
+:abstractmethod:
+
+```{autodoc2-docstring} bumpversion.versioning.functions.PartFunction.bump
+:parser: myst
+```
+
+````
+
+`````
+
+`````{py:class} IndependentFunction(value: typing.Union[str, int, None] = None)
+:canonical: bumpversion.versioning.functions.IndependentFunction
+
+Bases: {py:obj}`bumpversion.versioning.functions.PartFunction`
+
+```{autodoc2-docstring} bumpversion.versioning.functions.IndependentFunction
+:parser: myst
+```
+
+```{rubric} Initialization
+```
+
+```{autodoc2-docstring} bumpversion.versioning.functions.IndependentFunction.__init__
+:parser: myst
+```
+
+````{py:method} bump(value: typing.Optional[str] = None) -> str
+:canonical: bumpversion.versioning.functions.IndependentFunction.bump
+
+```{autodoc2-docstring} bumpversion.versioning.functions.IndependentFunction.bump
+:parser: myst
+```
+
+````
+
+`````
+
+`````{py:class} NumericFunction(optional_value: typing.Union[str, int, None] = None, first_value: typing.Union[str, int, None] = None)
+:canonical: bumpversion.versioning.functions.NumericFunction
+
+Bases: {py:obj}`bumpversion.versioning.functions.PartFunction`
+
+```{autodoc2-docstring} bumpversion.versioning.functions.NumericFunction
+:parser: myst
+```
+
+```{rubric} Initialization
+```
+
+```{autodoc2-docstring} bumpversion.versioning.functions.NumericFunction.__init__
+:parser: myst
+```
+
+````{py:attribute} FIRST_NUMERIC
+:canonical: bumpversion.versioning.functions.NumericFunction.FIRST_NUMERIC
+:value: >
+   'compile(...)'
+
+```{autodoc2-docstring} bumpversion.versioning.functions.NumericFunction.FIRST_NUMERIC
+:parser: myst
+```
+
+````
+
+````{py:method} bump(value: typing.Union[str, int]) -> str
+:canonical: bumpversion.versioning.functions.NumericFunction.bump
+
+```{autodoc2-docstring} bumpversion.versioning.functions.NumericFunction.bump
+:parser: myst
+```
+
+````
+
+`````
+
+`````{py:class} ValuesFunction(values: typing.List[str], optional_value: typing.Optional[str] = None, first_value: typing.Optional[str] = None)
+:canonical: bumpversion.versioning.functions.ValuesFunction
+
+Bases: {py:obj}`bumpversion.versioning.functions.PartFunction`
+
+```{autodoc2-docstring} bumpversion.versioning.functions.ValuesFunction
+:parser: myst
+```
+
+```{rubric} Initialization
+```
+
+```{autodoc2-docstring} bumpversion.versioning.functions.ValuesFunction.__init__
+:parser: myst
+```
+
+````{py:method} bump(value: str) -> str
+:canonical: bumpversion.versioning.functions.ValuesFunction.bump
+
+```{autodoc2-docstring} bumpversion.versioning.functions.ValuesFunction.bump
+:parser: myst
+```
+
+````
+
+`````
diff --git a/docsrc/reference/bumpversion/bumpversion.versioning.md b/docsrc/reference/bumpversion/bumpversion.versioning.md
@@ -0,0 +1,21 @@
+# {py:mod}`bumpversion.versioning`
+
+```{py:module} bumpversion.versioning
+```
+
+```{autodoc2-docstring} bumpversion.versioning
+:parser: myst
+:allowtitles:
+```
+
+## Submodules
+
+```{toctree}
+:titlesonly:
+:maxdepth: 1
+
+bumpversion.versioning.functions
+bumpversion.versioning.models
+bumpversion.versioning.conventions
+bumpversion.versioning.serialization
+```