search

click-contrib / sphinx-click

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

Hello World repository #66

Closed ssomnath closed 3 years ago

ssomnath commented 3 years ago

Is there a self-contained example demonstrating the use of sphinx-click? For example, I found this repository very helpful for following the procedure to get the recursion to work correctly with sphinx. If there isn't one, I could help put together a Hello World repository with your guidance and assistance.

stephenfin commented 3 years ago

The closest thing I'm aware of is the docs. We have a worked example here. Is that what you're looking for?

ssomnath commented 3 years ago

Thank you for responding very quickly.

Ah. I see. I was wondering if there were example working repositories I could refer to while I follow the documentation you have put up. I am not super familiar with click and am helping out with putting together documentation. So, an example working repository with all components would have been great.

This is the repository I am trying to document and here is the corresponding current click documentation that we would like to use sphinx-click for.

Like I said, I am planning on putting together such a repository using your documentation. If it is fine with you, could I ask you questions as I set up such a hello world repo?

stephenfin commented 3 years ago

Sure. We could probably include a sample hello world application in the root of this project if it would be helpful. Feel free to submit a PR if you think this makes sense. I'm happy to answer any questions too

ssomnath commented 3 years ago

Thank you very much for your support. Sorry I did not see your message about including the example within this repo. I just started putting together a repo here - https://github.com/ssomnath/sphinx-click_Hello-World

ssomnath commented 3 years ago

So the repository I put up does indeed work. I added some notes I took down when building the documentation. One could potentially add more complexity for demonstration purposes such as documenting additional groups, etc. Please let me know what you think about this.

stephenfin commented 3 years ago

I think we've done as much as we can do here. Thanks for the link to the starter project. I'm sure that will be helpful to others. As I noted previously, if you wishes to include this in the main project then I could help with that but what you have is more than good enough :smile: