Skip to content

Update changelog #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ox54 merged 1 commit into from
Mar 9, 2025
Merged

Update changelog #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Fixed
- Fixed issue where docstrings weren't displayed in the generated documentation when `pretty` option was enabled
- Command names are now wrapped in backticks (`) when using `pretty` option
- Show `help` and docstring(s) in generated docs when `pretty` is enabled

## [0.1.2] - 2025-03-05

### Added
- Added Pydantic as a dependency

### Changed
- Updated logo and branding colors
- Added new logo variants in SVG and PNG formats

## [0.1.1] - 2024-10-25

### Added
Expand All @@ -21,7 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Proper handling of optional and required parameters
- Correct parsing of default values in CLI options

## [0.1.0] - 2024-10-25
## [0.1.0] - 2024-10-24

### Added
- Initial release of mkdocs-typer2
Expand Down
8 changes: 2 additions & 6 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
[project]
name = "mkdocs-typer2"
version = "0.1.2"
version = "0.1.3"
description = "Mkdocs plugin for generating Typer CLI docs"
readme = "README.md"
requires-python = ">=3.10"
dependencies = [
"mkdocs>=1.6.1",
"pydantic>=2.9.2",
"typer>=0.12.5",
]
dependencies = ["mkdocs>=1.6.1", "pydantic>=2.9.2", "typer>=0.12.5"]

[project.scripts]
"mkdocs-typer2" = "mkdocs_typer2.cli:app"
Expand Down