mirrors
/
rails
mirror of https://github.com/rails/rails
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #19932 from axilleas/api_docs_guidelines 

Make sure you execute rake rdoc from rails root directory [ci skip]
This commit is contained in:
Yves Senn 2015-04-28 14:34:51 +02:00
parent 76fc205f99 86b6c77337
commit 6ccf3bfa6e
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
guides/source/api_documentation_guidelines.md
View File

@ -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

6
guides/source/ruby_on_rails_guides_guidelines.md
View File

@ -64,7 +64,9 @@ The guides and the API should be coherent and consistent where appropriate. In p
HTML Guides
-----------
Before generating the guides, make sure that you have the latest version of Bundler installed on your system. As of this writing, you must install Bundler 1.3.5 on your device.
Before generating the guides, make sure that you have the latest version of
Bundler installed on your system. As of this writing, you must install Bundler
1.3.5 or later on your device.
To install the latest version of Bundler, run `gem install bundler`.
@ -82,6 +84,8 @@ or
bundle exec rake guides:generate:html
```
Resulting HTML files can be found in the `./output` directory.
To process `my_guide.md` and nothing else use the `ONLY` environment variable:
```