Changes

6.2.0

New Features

  • Add a “Usage” label (rubric) before printing the command’s usage format.

6.1.0

New Features

  • Python 3.13 is now officially supported.

Upgrade Notes

  • Python 3.8 and Python 3.9 are no longer supported as they have reached end-of-life.

6.0.0

New Features

  • Now when the default value of an option is a string it will be rendered with quotes around it.

Upgrade Notes

  • click 7.x is no longer supported. The minimum click version now supported is 8.0.0.

  • sphinx < 4.0.0 is no longer supported.

Bug Fixes

  • If an option has an empty string default, docutils will no longer emit warnings saying CRITICAL: Unexpected section title or transition.

5.2.0

New Features

  • Python 3.12 is now officially supported.

  • typer.main.TyperArgument is a subclass of click.Argument that, among other things, adds a help attribute. If present this attribute will now be included in output.

Bug Fixes

  • Added support for show_default as defined in click context settings. This allows for option defaults to be rendered in the output. Consistent with click version 8.1.x, show_default is overridden by Command.show_default.

5.1.0

New Features

  • Added support for mocking imported modules during the build process. Mocked modules can either be specified from a sphinx_click_mock_imports variable, if specified, or by default using autodoc_mock_imports.

5.0.0

New Features

  • A number of events are now supported:

    • sphinx-click-process-description

    • sphinx-click-process-usage

    • sphinx-click-process-options

    • sphinx-click-process-arguments

    • sphinx-click-process-envvars

    • sphinx-click-process-epilog

    These allow you to plug in to the build process for documentation and post-process the generated command documentation. For more information, refer to the documentation.

Upgrade Notes

  • Python 3.7 is no longer supported as it has reached end-of-life.

4.4.0

New Features

  • Python 3.11 is now officially supported.

4.3.0

New Features

  • The auto_envvar_prefix parameter, which enables automatic environment variables for all parameters in a click application, is now supported. For more information on this feature, refer to the click documentation.