diff options
| author | Arthur Nogueira Neves <arthurnn@gmail.com> | 2014-06-06 19:50:54 -0500 |
|---|---|---|
| committer | Arthur Nogueira Neves <arthurnn@gmail.com> | 2014-06-06 19:50:54 -0500 |
| commit | a6c8cde83526e4ec5b1212b5e6d1e512ebf7c0ec (patch) | |
| tree | ab03faf312f8a53f155cbc6386d35ed6d8ffd860 /guides/source/api_documentation_guidelines.md | |
| parent | fadbc7c9eea63e9d8d6ef29b126db4bd3335785b (diff) | |
| parent | 19ef270923cfa498b904cb3cc4484c83e463f371 (diff) | |
| download | rails-a6c8cde83526e4ec5b1212b5e6d1e512ebf7c0ec.tar.gz rails-a6c8cde83526e4ec5b1212b5e6d1e512ebf7c0ec.tar.bz2 rails-a6c8cde83526e4ec5b1212b5e6d1e512ebf7c0ec.zip | |
Merge pull request #15542 from Gaurav2728/gaurav-remove_shutdown_link
remove rubyforge.org that was shut down [ci skip]
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
| -rw-r--r-- | guides/source/api_documentation_guidelines.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md index 2a3bb4e34d..0a55e31818 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/guides/source/api_documentation_guidelines.md @@ -13,7 +13,13 @@ After reading this guide, you will know: RDoc ---- -The Rails API documentation is generated with RDoc. Please consult the documentation for help with the [markup](http://rdoc.rubyforge.org/RDoc/Markup.html), and also take into account these [additional directives](http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html). +The [Rails API documentation](http://api.rubyonrails.org) is generated with RDoc. + +```bash + bundle exec rake rdoc +``` + +Resulting HTML files can be found and browsed at ./doc/rdoc directory. Just open index.html file in the browser and you're done. Wording ------- |