Changes

  • pre-commit: Migrate to ruff

  • pre-commit: Bump versions

6.0.0

  • FIX Format string defaults correctly

  • Remove errant prints

  • Drop support for click 7.x, Sphinx < 5.x

  • readthedocs: Use dirhtml builder

5.2.1

  • docs: Add discrete mocking section

  • actions: Integrate tox-gh-actions

  • Distinguish between click and asyncclick

  • tests: Set maxDiff

  • Skip test with click 7.x

  • FIX If the `help` of an argument is `None`, don’t fail

  • Add defusedxml to tox deps

  • Add defusedxml as test requirement

  • typing: Remove unused ignore

  • Add readthedocs config file

5.2.0

  • Fix show_default with context_settings

  • tests: Add tests for ‘commands’ option

  • Add support, testing for Python 3.12

  • Add release note for typer arg help text feature

  • Interpret help for arguments

  • typing: Update for latest types-docutils

5.1.0

  • tox: Remove py37 entries

  • Add support for mocking modules

  • docs: Fix indentation

  • setup: Add Sphinx classifier

5.0.1

  • Fix compatibility with Sphinx 7.2.x

5.0.0

  • Add release note for events support

  • Process events (#126)

  • Add release note for end of Python 3.7 support

  • setup.cfg: Add click keyword

  • Drop Python 3.7 support

  • tox: Use pre-commit for ‘style’ target

  • mypy: Follow imports

  • pre-commit: Enable black

  • pre-commit: Version bumps

  • examples: Add typing info

  • Typo

4.4.0

  • Add release note for Python 3.11 support

  • actions: Test Python 3.11

  • Points to alternative to complement Click-based CLI documentation

  • Add Sphinx extension classifier

  • Add pull request template

  • Trivial setup.py, setup.cfg changes

  • Render option defaults as literals

  • Change target Python version used for black

  • actions: Update to latest versions of actions

  • Use deep clone for GitHub actions

  • docs: Add more examples

  • tests: Add more application tests

  • Add our first “extension” test

  • Switch to pytest for testing

  • Run mypy as part of CI job

4.3.0

  • Fix typo

  • Add release note for auto_envvar_prefix support

  • add functionality to also render env-variables that are created via the ‘auto_envvar_prefix’ option

4.2.0

  • Extend pre-wrapped text support to options

  • tests: Use Command tests, not Group tests

  • tests: Add test for boolean options

4.1.0

  • docs: Don’t recommend using ‘setup.py’

  • docs: Indicate support for asyncclick

  • asyncclick target

  • docs: Remove ‘language’ configuration

  • docs: Add root directory to PATH for docs build

  • docs: Remove noise from conf.py

  • tox: Enable nitpicky mode for docs builds

4.0.3

  • Correct ‘get_command’ argument type error

4.0.2

  • Correctly ignore empty ‘commands’ parameter

4.0.1

  • docs: Correct typo

  • Configure mypy

  • Add typing hints

  • Pass Context, not self, to MultiCommand

  • Add test for truncation

4.0.0

  • Add Python 3.10 support, drop Python 3.6 support

  • Uncap coverage, remove test-requirements.txt

  • Update pre-commit hooks

  • Add support for click 8.1.x

  • setup: Update URL

3.1.0

  • Display ‘show_default’ string even when ‘default=None’

  • docs: Improve information on cross-referencing

  • docs: Update URLs

  • setup: Switch from hyphens to underscores

3.0.3

  • Handle iterables of iterables as default values

  • tests: Move tests to correct TestCase

  • Deduplicate help block formatting code

  • Add support for wrapping suppression using `b` in epilogs

  • tox: Allow us to specify a test

  • tox: Remove Travis remnants

  • pre-commit: Update requirements

  • Switch to GitHub Actions

3.0.2

  • Enable parallel modes

  • Return sphinx extension options

3.0.1

  • Update requirements.txt

  • travis: Drop pypy testing

  • travis: Fix config

3.0.0

  • Drop Sphinx, click version caps

  • Drop Python 2.7, click 6 support

  • support sphinx==4.0

2.7.1

  • Strip ANSI escape codes

2.7.0

  • Strip ANSI escape codes

  • Support numeric choices

  • Fix black issues

2.6.0

  • Don’t require pbr on runtime

  • Explicitly add used requires

  • CLN typos and nitpicks

  • TST formater for CommandCollection with != nesting

  • DOC add basic example with CommandCollection

  • ENH allow for grouped documentation with CommandCollection

  • add whitespace to option choice separator to allow wrapping

2.5.0

  • Make show-nested more granualar

  • Add support for epilogs

  • Support ‘metavar’

  • Prettier formatting of detailed opt information

  • Allow extension to be used as simply ‘sphinx_click’

  • trivial: Separate imports

2.4.0

  • tests: Add docstrings

  • Use ‘nested_parse_with_titles’

  • Switch to black

2.3.2

  • requirements: Add support for Sphinx 3.x

2.3.1

  • Make sphinx version in sync with the conda package

  • Fixed sphinx version in requirements.txt (#52)

2.3.0

  • improvement: remove the excessive comma in list.append() function call

  • improvement: describe when and why show_default can be a string

  • fix: when ‘show_default’ is a string use it as the default description

  • trivial: Unify ‘hidden’ checks

  • Don’t show hidden commands in toctree

  • trivial: Black fixups

  • Drop support for Python 3.4

2.2.0

  • Add pre-commit support

  • Misc formatting fixes

  • Add instruction to usage docs to enable extension (#45)

  • Change display format to pull options out of in line help text

  • Add click.Choice options to help text

  • Update sphinx supported version

2.1.0

  • Support and test Sphinx 2 and Python 3.7

2.0.1

  • Do not show hidden subcommands as valid command options

2.0.0

  • Misc formatting fixes

  • Remove use of ‘build_sphinx’

  • README: Add docs badge

  • Ignore hidden commands

  • Start testing Click 7.x, drop support for 5.x

  • Fix compatibility with Click 7.0

1.4.1

  • Use unique anchors for envvars

  • Log output

  • README: Add Travis badge

1.4.0

  • Use unique identifiers for envvars

  • travis: Update PyPI password

  • Add tests for disabled line rewrapping

  • Updated implementation of philipstarkey’s fix

  • Revert “tox: Start testing Python 3.7”

  • tox: Start testing Python 3.7

  • doc: Document how cross-referencing works

  • travis: Use travis to publish packages

  • tox: Add pypy testing

  • travis: Reformat file using travis linter

1.3.0

  • docs: Expand on what a “click object” is

  • Check type of object to document

  • trivial: Fix formatting issues

  • tox: Apply style changes

1.2.0

  • tests: Add tests for MultiCommand

  • Support lazyload commands

1.1.0

  • Use short_help if help is absent

  • trivial: style target for Tox

  • Improved code style using Yapf and ISort

  • travis: Add basic configuration

  • trivial: Fix broken pep8 target

  • Add :commands: option for click directive

1.0.4

  • Provide more context for import errors

1.0.3

  • Fix Sphinx 1.7 compatibility

  • Fix unicode from breaking module import

  • Add various _format_XXX functions

1.0.2

  • sorts the commands and subcommands

  • tox: Add ‘release’ target

1.0.1

  • docs: Add example for modifying ‘sys.path’

  • Handle commands without a docstring

  • README: Update usage example

1.0.0

  • Initial release

  • Basic project setup

  • Initial commit