Skip to content

feat(docs): use mkdocs-click for documenting EEST CLIs #985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 3, 2024

Conversation

danceratopz
Copy link
Member

@danceratopz danceratopz commented Dec 3, 2024

🗒️ Description

This PR ensures that our CLI documentation is single source by using:

  1. click's built-in help system to document CLIs (for terminal output), and,
  2. mkdocs-click, that generates html documentation from the click docstrings.

It also updates the evm_bytes CLI docs to have cleaner click docs and use mkdocs-click for its html docs. This fixes up the previous poor formatting of help strings in the terminal.

Online docs example output:
image

🔗 Related Issues

None.

✅ Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

@danceratopz danceratopz added scope:docs Scope: Documentation type:feat type: Feature scope:tooling Scope: Python tools (uv, ruff, tox,...) labels Dec 3, 2024
@danceratopz danceratopz self-assigned this Dec 3, 2024
@danceratopz danceratopz changed the title feat(docs): use mkdocs-click for documenting EEST's CLIs feat(docs): use mkdocs-click for documenting EEST CLIs Dec 3, 2024
@danceratopz danceratopz mentioned this pull request Dec 3, 2024
5 tasks
@danceratopz danceratopz merged commit 88c1401 into main Dec 3, 2024
5 checks passed
@danceratopz danceratopz deleted the doc/add-cli-doc-infra branch December 3, 2024 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:docs Scope: Documentation scope:tooling Scope: Python tools (uv, ruff, tox,...) type:feat type: Feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants