diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2015-04-28 12:47:39 +0300 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2015-04-28 15:33:13 +0300 |
| commit | 86b6c773378383c902c24b5b5917177bde4e8d62 (patch) | |
| tree | 51da38fef8d93c767dbb75f4e942f1eaf4cc82c0 /guides/source/api_documentation_guidelines.md | |
| parent | cdf3548a452bbe5cddaad0a398d4266b36f9e388 (diff) | |
| download | rails-86b6c773378383c902c24b5b5917177bde4e8d62.tar.gz rails-86b6c773378383c902c24b5b5917177bde4e8d62.tar.bz2 rails-86b6c773378383c902c24b5b5917177bde4e8d62.zip | |
Update instructions to build guides locally [ci skip]
1. Make clear where rake rdoc is executed
2. Make clear where the generated HTML files for the guides are stored
3. Use bundler 1.3.5 or later
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 |