From f9abb3077b74e751cc4aadf7767e1ff465d1aed6 Mon Sep 17 00:00:00 2001 From: Jannis Mainczyk Date: Mon, 25 Sep 2023 09:53:27 +0200 Subject: [PATCH 1/3] ops: list mkdocs as doc requirement --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index eea793b2..d7dbe85e 100644 --- a/pyproject.toml +++ b/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", From 0a9b0739fa03d5a5e317655470e7f3bb89d72d49 Mon Sep 17 00:00:00 2001 From: Jannis Mainczyk Date: Mon, 25 Sep 2023 10:39:42 +0200 Subject: [PATCH 2/3] ops(ci): fix doc requirements no longer installed --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 748c5c6a..9c8853eb 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -44,7 +44,7 @@ docs: - dist script: - apt-get update && apt-get install tree - - pip install build/dist/*.whl + - pip install `ls build/dist/*.whl`[doc] - make docs artifacts: paths: From ae2c01786789c3f9923d6e7a40e4329cefc3c01b Mon Sep 17 00:00:00 2001 From: Jannis Mainczyk Date: Mon, 25 Sep 2023 16:42:33 +0200 Subject: [PATCH 3/3] bump 0.0.3 -> 0.0.4 --- .bumpversion.cfg | 5 +++-- CHANGELOG.md | 15 ++++++++++++++- src/init_python_project/cli.py | 2 +- 3 files changed, 18 insertions(+), 4 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index e3f2f528..b775c897 100644 --- a/.bumpversion.cfg +++ b/.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] diff --git a/CHANGELOG.md b/CHANGELOG.md index 90fdac12..f13a0136 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/src/init_python_project/cli.py b/src/init_python_project/cli.py index 42acfc26..7499b9a2 100644 --- a/src/init_python_project/cli.py +++ b/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: