search

python-wheel-build / fromager

Build your own wheels
https://pypi.org/project/fromager/
Apache License 2.0
3 stars 9 forks source link

generate CLI documentation #217

Closed dhellmann closed 1 month ago

dhellmann commented 1 month ago

We should produce automatically generated documentation for all commands and CLI options.

rd4398 commented 1 month ago

Do we want to use something like https://pypi.org/project/md-click/? Or it is to be done without using external libraries?

dhellmann commented 1 month ago

If there are tools that will do it, that's fine.

We should consider how this would fit into an overall documentation build, too. I usually use Sphinx for python libs so I can publish on readthedocs.org, but that's not a hard requirement. If we don't publish there we need to figure out how we will publish.

rd4398 commented 1 month ago

Okay, I will research a bit more then