Merge branch 'main' into main-github

Author: jannismain

.bumpversion.cfg

@@ -1,6 +1,7 @@
 [bumpversion]
-current_version = 0.0.3
-message = bump v{current_version} -> v{new_version}
+current_version = 0.0.4
+commit = True
+message = bump {current_version} -> {new_version}
 
 [bumpversion:file:.bumpversion.cfg]
 

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.0.4] - 2023-09-25
+
+### Changed
+
+- rename `use_precommit` and `use_bumpversion` options to simply `precommit` and `bumpversion`
+
+### Fixed
+
+- doc template: all templates files are included now
+- do not include doc requirements in `make install-dev` if no docs are configured
+- documentation examples are now built using the cli
+
 ## [0.0.3] - 2023-09-21
 
 ### Added
@@ -69,7 +81,8 @@ An example project (comparable to [pypa/sampleproject]) can be found at [jannism
 
 - trove classifiers (only relevant when publishing to PyPI)
 
-[unreleased]: https://github.com/jannismain/python-project-template/compare/v0.0.3...HEAD
+[unreleased]: https://github.com/jannismain/python-project-template/compare/v0.0.4...HEAD
+[0.0.4]: https://github.com/jannismain/python-project-template/compare/0.0.3...0.0.4
 [0.0.3]: https://github.com/jannismain/python-project-template/compare/0.0.2...0.0.3
 [0.0.2]: https://github.com/jannismain/python-project-template/compare/0.0.1...0.0.2
 [0.0.1]: https://github.com/jannismain/python-project-template/releases/tag/0.0.1

pyproject.toml

@@ -35,6 +35,7 @@ fallback_version = "0.0.0"
 dev = ["black", "pre-commit", "ruff"]
 test = ["pytest", "pytest-venv", "pytest-xdist", "pexpect"]
 doc = [
+    "mkdocs",
     "mkdocs-material",
     "mkdocs-git-revision-date-localized-plugin",
     "mkdocs-literate-nav",

src/init_python_project/cli.py

@@ -11,7 +11,7 @@
 
 app = Typer()
 
-__version__ = "0.0.3"
+__version__ = "0.0.4"
 
 
 def version_callback(value: bool) -> None: