diff options
| author | Yves Senn <yves.senn@gmail.com> | 2015-04-28 14:34:51 +0200 |
|---|---|---|
| committer | Yves Senn <yves.senn@gmail.com> | 2015-04-28 14:34:51 +0200 |
| commit | 6ccf3bfa6e951fabf75352656a707f3a501b1cc2 (patch) | |
| tree | c49e5f456d95a3577696d73446c33a18af91669e /guides/source/api_documentation_guidelines.md | |
| parent | 76fc205f9970208d597774095eccdaf07559803b (diff) | |
| parent | 86b6c773378383c902c24b5b5917177bde4e8d62 (diff) | |
| download | rails-6ccf3bfa6e951fabf75352656a707f3a501b1cc2.tar.gz rails-6ccf3bfa6e951fabf75352656a707f3a501b1cc2.tar.bz2 rails-6ccf3bfa6e951fabf75352656a707f3a501b1cc2.zip | |
Merge pull request #19932 from axilleas/api_docs_guidelines
Make sure you execute rake rdoc from rails root directory [ci skip]
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
| -rw-r--r-- | guides/source/api_documentation_guidelines.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md index b385bdbe83..46c9013087 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/guides/source/api_documentation_guidelines.md @@ -16,7 +16,8 @@ RDoc ---- The [Rails API documentation](http://api.rubyonrails.org) is generated with -[RDoc](http://docs.seattlerb.org/rdoc/). +[RDoc](http://docs.seattlerb.org/rdoc/). To generate it, make sure you are +in the rails root directory, run `bundle install` and execute: ```bash bundle exec rake rdoc |