search

rails / thor

Thor is a toolkit for building powerful command-line interfaces.
http://whatisthor.com/
MIT License
5.12k stars 552 forks source link

autogenerate user documentation #296

Open mjobin-mdsol opened 11 years ago

mjobin-mdsol commented 11 years ago

is there already something in place to generate documentation from our thor task list ?

if there is none, how would you recommend we do it. if I can spend the time on it, It would turn into a PR ;)

thanks

eventualbuddha commented 11 years ago

@wycats or @indirect might know something about this as relates to the rails and bundle commands, since they use thor and have a fair amount of documentation.

sferik commented 11 years ago

I've talked to @wycats about programmatically generating man pages with thor. It's on the long-term feature roadmap but that's another way of saying it may never happen unless someone becomes motivated to do it. I'd love to see a PR for this.

indirect commented 11 years ago

the current options are pretty much: 1) write very, very long strings that you pass to desc and long_desc, 2) write separate manpages. Bundler has both. :crying_cat_face: