Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[unreleased]

[0.1.4] - 2025-03-15

Added

• Added support for Python 3.13
• Added per-block configuration for pretty option in documentation directives
• Added justfile for common development tasks
• Added docs/cli-pretty.md example for pretty-formatted CLI documentation
• Added docs/changelog.md that includes the project's CHANGELOG

Changed

• Enhanced documentation with more detailed usage instructions and examples
• Updated navigation structure in mkdocs.yaml
• Improved TyperProcessor to support overriding global pretty setting at the block level

[0.1.3] - 2025-03-09

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 usingpretty` 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

• Pretty output formatting option for CLI documentation
  • Support for table-based documentation layout
• Automatic command parsing and documentation generation
• Integration with Typer's built-in documentation system

Changed

• Improved documentation rendering with markdown tables
• Enhanced support for command arguments and options display

Fixed

• Proper handling of optional and required parameters
• Correct parsing of default values in CLI options

[0.1.0] - 2024-10-24

Added

• Initial release of mkdocs-typer2
• Basic MkDocs plugin functionality
• Support for Typer CLI documentation generation
• Integration with MkDocs Material theme
• GitHub Actions for testing and deployment
• Basic test coverage