API docs generation tool [closed]
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this questionI have a RESTful API written on RubyOnRails(restfulie gem). What is the best way to generate 开发者_Go百科api documentation from project sources?
rake doc:app
will turn your rdoc formatted comments for your methods into properly formatted html
idlefingers has it right, but here is the complete answer for newbies:
- Include rdoc in your Gemfile: gem "rdoc"
- Run $ rake doc:app to generate the documentation
- Access the rdoc by opening the doc/app/index.html file in your browser
精彩评论