diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4fdf2532..514ac365 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -64,21 +64,20 @@ The tables below list all prerequisites along with the minimum required version #### Additional prerequisites for developing cmd2 -| Prerequisite | Minimum Version | Purpose | -| ------------------------------------------------------------------------------------------ | --------------- | --------------------------------- | -| [codecov](http://doc.pytest.org/en/latest/) | `2.1.13` | Cover coverage reporting | -| [invoke](https://www.pyinvoke.org/) | `2.2.0` | Command automation | -| [griffe_typingdoc](https://github.com/mkdocstrings/griffe-typingdoc) | `0.2.7` | mkdocstrings extension for typing | -| [mypy](https://mypy-lang.org/) | `1.13.0` | Static type checker | -| [pytest](https://docs.pytest.org/en/stable/) | `3.0.6` | Unit and integration tests | -| [pytest-cov](http://doc.pytest.org/en/latest/) | `6.0.0` | Pytest code coverage | -| [pytest-mock](https://pypi.org/project/pytest-mock/) | `3.14.0` | Pytest mocker fixture | -| [mkdocs-include-markdown-plugin](https://pypi.org/project/mkdocs-include-markdown-plugin/) | `7.1.2` | MkDocs Plugin include MkDn | -| [mkdocs-macros-plugin](https://mkdocs-macros-plugin.readthedocs.io/) | `1.3.7` | MkDocs Plugin for macros | -| [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) | `9.5.49` | Documentation | -| [mkdocstrings[python]](https://mkdocstrings.github.io/) | `0.27.0` | MkDocs Plugin for Python AutoDoc | -| [ruff](https://github.com/astral-sh/ruff) | `0.7.3` | Fast linter and formatter | -| [uv](https://github.com/astral-sh/uv) | `0.5.1` | Python package management | +| Prerequisite | Minimum Version | Purpose | +| ------------------------------------------------------------------------------------------ | --------------- | -------------------------------- | +| [codecov](http://doc.pytest.org/en/latest/) | `2.1.13` | Cover coverage reporting | +| [invoke](https://www.pyinvoke.org/) | `2.2.0` | Command automation | +| [mypy](https://mypy-lang.org/) | `1.13.0` | Static type checker | +| [pytest](https://docs.pytest.org/en/stable/) | `3.0.6` | Unit and integration tests | +| [pytest-cov](http://doc.pytest.org/en/latest/) | `6.0.0` | Pytest code coverage | +| [pytest-mock](https://pypi.org/project/pytest-mock/) | `3.14.0` | Pytest mocker fixture | +| [mkdocs-include-markdown-plugin](https://pypi.org/project/mkdocs-include-markdown-plugin/) | `7.1.2` | MkDocs Plugin include MkDn | +| [mkdocs-macros-plugin](https://mkdocs-macros-plugin.readthedocs.io/) | `1.3.7` | MkDocs Plugin for macros | +| [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) | `9.5.49` | Documentation | +| [mkdocstrings[python]](https://mkdocstrings.github.io/) | `0.27.0` | MkDocs Plugin for Python AutoDoc | +| [ruff](https://github.com/astral-sh/ruff) | `0.7.3` | Fast linter and formatter | +| [uv](https://github.com/astral-sh/uv) | `0.5.1` | Python package management | If Python is already installed in your machine, run the following commands to validate the versions: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ba1f4663..45cbdbc3 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,7 +8,7 @@ repos: - id: trailing-whitespace - repo: https://github.com/astral-sh/ruff-pre-commit - rev: "v0.9.2" + rev: "v0.9.3" hooks: - id: ruff-format args: [--config=pyproject.toml] diff --git a/CHANGELOG.md b/CHANGELOG.md index 9861b33a..ea4209fe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,16 @@ - Added `RawDescriptionCmd2HelpFormatter`, `RawTextCmd2HelpFormatter`, `ArgumentDefaultsCmd2HelpFormatter`, and `MetavarTypeCmd2HelpFormatter` and they all use `rich-argparse`. +## 2.5.11 (January 25, 2025) + +- Bug Fixes + - Fixed duplicated parameter tables in API documentation. + +## 2.5.10 (January 25, 2025) + +- Bug Fixes + - Fixed docstring style for MkDocs API documentation so parameters are displayed properly. + ## 2.5.9 (January 17, 2025) - Bug Fixes diff --git a/Pipfile b/Pipfile index d7990d88..58e86480 100644 --- a/Pipfile +++ b/Pipfile @@ -16,7 +16,6 @@ cmd2 = { editable = true, path = "." } cmd2_ext_test = { editable = true, path = "plugins/ext_test" } codecov = "*" gnureadline = { version = "*", sys_platform = "== 'darwin'" } -griffe-typingdoc = "*" invoke = "*" ipython = "*" mypy = "*" diff --git a/docs/overview/installation.md b/docs/overview/installation.md index b3a63536..e7bcf584 100644 --- a/docs/overview/installation.md +++ b/docs/overview/installation.md @@ -60,7 +60,7 @@ This will also install the required 3rd-party dependencies. !!! warning - Versions of `cmd2` before 0.8.9 should be considered to be of unstable "beta" quality and should not be relied upon for production use. If you cannot get a version >= 0.8.9 from your OS repository, then we recommend installing from either pip or GitHub - see [Pip Install](installation.md#pip_install) or [Install from GitHub](installation.md#github). + Versions of `cmd2` before 1.0.0 should be considered to be of unstable "beta" quality and should not be relied upon for production use. If you cannot get a version >= 0.8.9 from your OS repository, then we recommend installing from either pip or GitHub - see [Pip Install](installation.md#pip_install) or [Install from GitHub](installation.md#github). ## Upgrading cmd2 diff --git a/mkdocs.yml b/mkdocs.yml index c421960a..0453dafa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,8 +72,6 @@ plugins: handlers: python: options: - extensions: - - griffe_typingdoc show_root_heading: true show_if_no_docstring: true preload_modules: diff --git a/pyproject.toml b/pyproject.toml index 87eb2335..ebb13ace 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -46,7 +46,6 @@ build = ["build>=1.2.1", "setuptools>=64", "setuptools-scm>=8"] dev = [ "black>=24", "codecov>=2", - "griffe-typingdoc>=0.2", "invoke>=2", "mkdocs-git-revision-date-localized-plugin>=1.3", "mkdocs-include-markdown-plugin>=6", @@ -63,7 +62,6 @@ dev = [ ] docs = [ "black>=24", - "griffe-typingdoc>=0.2", "mkdocs-git-revision-date-localized-plugin>=1.3", "mkdocs-include-markdown-plugin>=6", "mkdocs-macros-plugin>=1",