click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications
MIT License
212 stars 57 forks source link

Add reference to complementary Click CLI documentation helpers #117

Closed kdeldycke closed 1 year ago

kdeldycke commented 1 year ago

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

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:

kdeldycke commented 1 year ago

Thanks @stephenfin for the fast merge!

kdeldycke commented 1 year ago

And sorry, I just realized there's a tiny typo. Made a PR to fix that at https://github.com/click-contrib/sphinx-click/pull/118