Giter VIP home page Giter VIP logo

Comments (6)

stephenfin avatar stephenfin commented on May 28, 2024

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

from sphinx-click.

ssomnath avatar ssomnath commented on May 28, 2024

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?

from sphinx-click.

stephenfin avatar stephenfin commented on May 28, 2024

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

from sphinx-click.

ssomnath avatar ssomnath commented on May 28, 2024

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

from sphinx-click.

ssomnath avatar ssomnath commented on May 28, 2024

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.

from sphinx-click.

stephenfin avatar stephenfin commented on May 28, 2024

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 😄

from sphinx-click.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.