diff options
| author | Gaurav Sharma <gaurav2728@gmail.com> | 2014-06-06 17:10:36 +0530 |
|---|---|---|
| committer | Gaurav Sharma <gaurav2728@gmail.com> | 2014-06-06 22:26:56 +0530 |
| commit | 19ef270923cfa498b904cb3cc4484c83e463f371 (patch) | |
| tree | 246aa0e4b4f0f3c75d4b9dd91b6aa662ba1d9536 /guides/source/api_documentation_guidelines.md | |
| parent | 0502189b504640a95a4729fac5c6a41c27de960f (diff) | |
| download | rails-19ef270923cfa498b904cb3cc4484c83e463f371.tar.gz rails-19ef270923cfa498b904cb3cc4484c83e463f371.tar.bz2 rails-19ef270923cfa498b904cb3cc4484c83e463f371.zip | |
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 ------- |