feat(docs): use mkdocs-click
for documenting EEST CLIs
#985
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.
🗒️ Description
This PR ensures that our CLI documentation is single source by using:
click
's built-in help system to document CLIs (for terminal output), and,mkdocs-click
, that generates html documentation from the click docstrings.It also updates the
evm_bytes
CLI docs to have cleanerclick
docs and usemkdocs-click
for its html docs. This fixes up the previous poor formatting of help strings in the terminal.Online docs example output:

🔗 Related Issues
None.
✅ Checklist
mkdocs serve
locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.