v8.5.0
- Breaking: Rename the
--show-paramsflag to--params. Its parameter ID changes fromshow_paramstoparams, its environment variable suffix from_SHOW_PARAMSto_PARAMS, andclick-extra wrap --show-paramsbecomesclick-extra wrap --params.ShowParamsOptionand@show_params_optionkeep their names. - Add the
click_extra.sphinx.myst_docstringsSphinx extension: write Python docstrings in MyST markdown, transparently converted to reST at build time, keepingsphinx.ext.autodocandsphinx_autodoc_typehintsunmodified. Absorbed fromrepomatic.myst_docstrings. - Add a
convert-to-mystsubcommand migrating a package's reST docstrings and comments to MyST in place, idempotently: string literals and other runtime code pass through byte-for-byte. Absorbed fromrepomatic, along with thesphinx-apidocstub converterclick_extra.rst_to_mystand the publicconvert_source(). - Add a
:mirror:flag to thepython:renderSphinx directive: the block's generated Markdown is mirrored into the source.mdbetween<!-- mirror -->markers, reviewable in raw diffs; builds regenerate it in memory, never writing to the source. - Extend
click-extra refresh-directivesto also refreshpython:render:mirror:regions, alongside{matrix}blocks, by executing each mirror block's Python. - Add a
start_new_sessionoption torun_cli(): the child leads its own POSIX session and process group, and every kill path signals the whole group, so grandchildren are reaped. Off by default to keep interactive prompts working; no-op on Windows. - Add a
themesdemo subcommand (click-extra themes) printing a sample help screen rendered under every built-in theme, for a quick terminal preview of all palettes. - Promote
ctx.render_tableandctx.print_tableto methods onclick_extra.Context, reading the--table-formatand--sort-byselections from the context's sharedmetaso they work from any subcommand.TableFormatOptionandSortByOptionremain drop-ins on click and cloup commands;ctx.render_tablenow honors--sort-by. - Warn on configuration keys unknown to the
config_schemawhen the section is schema-only, instead of dropping them silently; strict mode still raises, and sections mixing CLI parameters stay silent. Exposed aswarn_unknownonmake_schema_callable()andschema_warn_unknownonrun_config_validation(). - Convert all of click-extra's own docstrings and comments from reST to MyST.
- Fix a group-level
--themenot reaching the CLI wrapped byclick-extra wrap: the target's help now renders in the chosen palette instead of falling back to the defaultdarktheme. - Fix
click-extra refresh-directivesrewriting{matrix}examples nested inside longer code fences: documented illustrations are copied verbatim, never refreshed or executed.
Full changelog: v8.4.0...v8.5.0