Devops: Remove verdi tui
from CLI reference documentation
#6464
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
verdi-autodocs
pre-commit hook automatically generates the reference documentation forverdi
. It does so based on the available commands. Theverdi tui
command is added dynamically if and only if the optional dependencytrogon
is installed.Since having the dependency installed slows down the loading time
verdi
significantly, many dev environments prefer not to install it. However, this leads to theverdi-autodocs
hook always failing as it removes theverdi tui
section from the docs. The developer then has to manually reset the changes and rungit commit
with--no-verify
.This is annoying enough that as a workaround the
verdi-autodocs
hook now skips theverdi tui
command when generating the docs.