datafolklabs / cement

Application Framework for Python
http://builtoncement.com
BSD 3-Clause "New" or "Revised" License
1.23k stars 120 forks source link

Sphinx extension #526

Open ss-remygreinhofer opened 5 years ago

ss-remygreinhofer commented 5 years ago

Cement Issue Reporting and Feature Requests

Is there any sphinx extension for Cement? Something similar to sphinx-click?

derks commented 5 years ago

There is not, though it sounds like something that would be nice to have. I'd have to spend some time with sphinx-click to wrap my head around what it is doing, and everything it provides.

ss-remygreinhofer commented 5 years ago

Would it be possible to leverage the sphinx-argparse extension to achieve this?

It looks like it would work out of the box if we could provide the function that returns an instance of the argparse.ArgumentParser class (https://sphinx-argparse.readthedocs.io/en/stable/usage.html).

anshrma commented 4 years ago

@ss-remygreinhofer / @derks - Any pointers on how to get sphinx-argparse / something similar working to generate the CLI usage guide , similar to how sphinx-click does ?

fdaguin commented 1 year ago

Also interested on how to fetch an instance of argparse.ArgumentParser for argparse-manpage to consume it.