Converted documentation to use MkDocs

Author: coordt

.gitignore

@@ -78,11 +78,6 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs
-docsrc/_build/
-docsrc/_autosummary
-
 # PyBuilder
 .pybuilder/
 target/

.pre-commit-config.yaml

@@ -23,7 +23,11 @@ repos:
       - id: check-symlinks
       - id: check-toml
       - id: check-yaml
-        exclude: test.*
+        exclude: |
+          (?x)^(
+            test.*|
+            mkdocs.yml
+          )$
         args: [--allow-multiple-documents]
       - id: debug-statements
       - id: end-of-file-fixer

README.md

@@ -15,6 +15,7 @@
 > - Add better configuration validation using [Pydantic](https://docs.pydantic.dev)
 > - Make the code and tests easier to read and maintain
 
+<!--start-->
 
 ## Overview
 
@@ -31,12 +32,6 @@ Bump My Version's purpose is to:
     - Tagging releases
     - Reading version numbers from tags
 
-
-## Future Direction
-
-- Switch having both the version part and files to change as arguments on the command line.
-- 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)
-
 ## Installation
 
 You can download and install the latest version of this software from the Python package index (PyPI) as follows:
@@ -51,10 +46,6 @@ Please find the changelog here: [CHANGELOG.md](CHANGELOG.md)
 
 ## Usage for version incrementing
 
-> **NOTE:** 
->
-> Throughout this document, you can use `bumpversion` or `bump-my-version` interchangeably.
-
 There are two modes of operation: On the command line for single-file operation and using a configuration file (`pyproject.toml` or `.bumpversion.toml`) for more complex multi-file operations.
 
 > **WARNING:**
@@ -161,3 +152,5 @@ workflow, as it is intended to be very versatile.
 ## License
 
 bump-my-version is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
+
+<!--end-->

docsrc/LICENSE

@@ -1,2 +1 @@
-```{include} ../LICENSE
-```
+{% include-markdown "../LICENSE" %}

docsrc/Makefile

@@ -16,26 +16,54 @@
   margin: 0;
 }
 
-dl.field-list {
+.field-list > dl {
+  --gap: 1rem;
+  --line-offset: calc(var(--gap) / 2);
+  --line-thickness: 1px;
+  --line-color: #e0e0e0;
+
   display: grid;
   grid-template-columns: fit-content(30%) auto;
+  grid-gap: var(--gap);
   margin-bottom: 1rem;
+  overflow: hidden;
 }
 
-dl.field-list > dt {
+.field-list > dl > dt {
+  text-align: right;
   font-weight: bold;
   word-break: break-word;
-  padding-left: 0.5em;
-  padding-right: 5px;
+  position: relative;
 }
 
-dl.field-list > dd {
-  padding-left: 0.5em;
+[dir=ltr] .field-list > dl > dd {
   margin-top: 0;
   margin-left: 0;
   margin-bottom: 0;
+  position: relative;
+}
+
+/* Pseudo Element Shared Styling */
+.field-list > dl > dt::before,
+.field-list > dl > dt::after,
+.field-list > dl > dd::before,
+.field-list > dl > dd::after {
+   content: '';
+   position: absolute;
+   background-color: var(--line-color);
+   z-index: 1;
 }
 
+/* Row Borders */
+.field-list > dl > dt::after,
+.field-list > dl > dd::after {
+  inline-size: 100vw;
+  block-size: var(--line-thickness);
+  inset-inline-start: 0;
+  inset-block-start: calc(var(--line-offset) * -1);
+}
+
+
 figure {
   padding-bottom: .75rem;
   padding-top: .5rem;

docsrc/_static/bump-my-version-logo.svg

@@ -1,2 +1 @@
-```{include} ../CHANGELOG.md
-```
+{% include-markdown "../CHANGELOG.md" %}

docsrc/_static/css/custom.css

@@ -1,2 +1 @@
-```{include} ../CONTRIBUTING.md
-```
+{% include-markdown "../CONTRIBUTING.md" rewrite-relative-urls=false %}

docsrc/changelog.md

@@ -1,22 +1,9 @@
 # Bump My Version
 
-```{toctree}
----
-maxdepth: 2
-caption: Contents
----
-Introduction <readme>
-usage
-tutorials/index
-howtos/index
-reference/index
-explanation/index
-CONTRIBUTING
-CHANGELOG
-```
-
-## Indices and tables
-
-* {ref}`genindex`
-* {ref}`modindex`
-* {ref}`search`
+{% 
+    include-markdown 
+    "../README.md" 
+    start="<!--start-->" 
+    end="<!--end-->"
+    rewrite-relative-urls=false
+%}

docsrc/conf.py

@@ -0,0 +1,8 @@
+# Command-line Interface
+
+
+::: mkdocs-click
+    :module: bumpversion.cli
+    :command: cli
+    :prog_name: bump-my-version
+    :style: table