Comments (6)
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.
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.
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.
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.
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.
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)
- add build-backend to pyproject.toml
- 4.0.0: sphinx warnings `reference target not found` HOT 7
- Missing detection of envvars via auto_envvar_prefix-option HOT 1
- Extend \b rewrapping to click options HOT 2
- Nested subcommands improvement HOT 1
- Supports `.. click:example::` and `.. click:run::` directives HOT 3
- Option defaults with escape characters don't render correctly HOT 5
- <class ‘click.core.Command’>” of type “scripts.my module:mycommand” is not click.Command or click.Group.”click.BaseCommand” HOT 1
- metavar in docs does not match metavar in help output HOT 2
- Missing show_default detection via context_settings. HOT 1
- _format_envvars does not seem to support auto_envvar_prefix on group HOT 1
- remove "Required argument" from every click arg HOT 1
- Sphinx_click not working with Read The Docs HOT 2
- Issue with sphinx 7.0 HOT 2
- "\b" prevents formatting HOT 1
- Support myst-parser HOT 3
- Document sub-command only
- Show list of commands HOT 1
- Tests fail with click 8.1.x HOT 1
- :nested: full doesn't work anymore HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinx-click.