diff --git a/docs/source/reference/command_line.rst b/docs/source/reference/command_line.rst index 530c4e0b66..50e69919e0 100644 --- a/docs/source/reference/command_line.rst +++ b/docs/source/reference/command_line.rst @@ -613,21 +613,6 @@ Below is a list with all available subcommands. version Print the current version of the storage schema. -.. _reference:command-line:verdi-tui: - -``verdi tui`` -------------- - -.. code:: console - - Usage: [OPTIONS] - - Open Textual TUI. - - Options: - --help Show this message and exit. - - .. _reference:command-line:verdi-user: ``verdi user`` diff --git a/utils/validate_consistency.py b/utils/validate_consistency.py index aa72e23863..297dfccab8 100644 --- a/utils/validate_consistency.py +++ b/utils/validate_consistency.py @@ -119,6 +119,14 @@ def validate_verdi_documentation(): block = [f"{header}\n{'=' * len(header)}\n{message}\n\n"] for name, command in sorted(verdi.commands.items()): + if name == 'tui': + # This command is only generated when the optional dependency ``trogon`` is installed. It provides a TUI + # version of ``verdi``. However, since it is optional, if a development environment does not have it + # installed, this check will always fail as the generated docs are different. Since ``trogon`` significantly + # slows down tab-completion of ``verdi``, many dev environments do not want to have it installed. As a + # workaround, we are excluding this command from the automatically generated reference documentation. + continue + ctx = click.Context(command, terminal_width=width) header_label = f'.. _reference:command-line:verdi-{name}:'