Develop (#32)

fixes #31

Author: fleetingbytes

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 <!-- towncrier release notes start -->
 
+## [0.2.3](https://github.com/Nagidal/hatch-semver/tree/0.2.3) - 2022-11-15
+
+
+### Documentation
+
+- Separated home.md from README.md [#31](https://github.com/Nagidal/hatch-semver/issues/31)
+
+
 ## [0.2.2](https://github.com/Nagidal/hatch-semver/tree/0.2.2) - 2022-11-15
 
 

README.md

@@ -21,7 +21,7 @@ set version scheme to `semver`:
 ```toml
 [tool.hatch.version]
 path = "src/<your_project>/__about__.py"
-validate-bump = True
+validate-bump = true
 scheme = "semver"
 ```
 

docs/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 <!-- towncrier release notes start -->
 
+## [0.2.2](https://github.com/Nagidal/hatch-semver/tree/0.2.2) - 2022-11-15
+
+
+### Documentation
+
+- Removed api-docs [#29](https://github.com/Nagidal/hatch-semver/issues/29)
+
+
 ## [0.2.1](https://github.com/Nagidal/hatch-semver/tree/0.2.1) - 2022-11-15
 
 

docs/README.md renamed to docs/home.md

@@ -1,7 +1,7 @@
 site_name: Hatch Semver
 
 nav:
-  - Home: "README.md"
+  - Home: "home.md"
   - Changelog: "CHANGELOG.md"
   - "User Guide":
     - Commands: "user_guide/1-commands.md"
@@ -12,11 +12,7 @@ docs_dir: "docs"
 site_dir: "user-site"
 
 watch:
-<<<<<<< HEAD
   - "docs"
-=======
-  - "user-docs"
->>>>>>> master
 
 theme:
   name: "material"

mkdocs.yml

@@ -93,18 +93,19 @@ fmt = [
 [tool.hatch.envs.docs]
 dependencies = [
     "mkdocs",
-    "pdoc3",
     "mkdocs-material",
+    "pdoc3",
+    "towncrier",
 ]
 
 [tool.hatch.envs.docs.scripts]
 build = "pdoc --html --force --output-dir api-site hatch_semver"
 serve = "pdoc --http : hatch_semver"
 userve = [
-    "copy /Y README.md docs",
     "copy /Y CHANGELOG.md docs",
     "mkdocs serve",
 ]
+tc = "towncrier build --yes"
 
 [[tool.hatch.envs.test.matrix]]
 python = ["310"]

pyproject.toml

@@ -8,4 +8,4 @@
 __maintainer__ = __author__
 __maintainer_email__ = __author_email__
 __release_date__ = date(year=2022, month=11, day=13)
-__version__ = "0.2.2"
+__version__ = "0.2.3"