[x] Ran test suite and style checks and built documentation (tox)
Further details
Here are some examples of real projects using click-extra's .. click:run:: to render the output of their --help option, followed by the rendering of .. click:: directive from sphinx-click extension:
Summary
As suggested by @stephenfin at https://github.com/click-contrib/sphinx-click/issues/110#issuecomment-1208039848, here is a little update to point users to complementary tools to help them document their Click-based CLI.
This PR also fixes some rST style rendering in the
README.rst
.Tasks
reno
)tox
)Further details
Here are some examples of real projects using
click-extra
's.. click:run::
to render the output of their--help
option, followed by the rendering of.. click::
directive fromsphinx-click
extension: