Skip to content
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

Sphinx extension #526

Open
ss-remygreinhofer opened this issue Aug 14, 2018 · 4 comments
Open

Sphinx extension #526

ss-remygreinhofer opened this issue Aug 14, 2018 · 4 comments

Comments

@ss-remygreinhofer
Copy link

Cement Issue Reporting and Feature Requests

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

@derks
Copy link
Member

derks commented Aug 14, 2018

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
Copy link
Author

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
Copy link

anshrma commented Mar 6, 2020

@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
Copy link

fdaguin commented Jul 15, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants