aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source
diff options
context:
space:
mode:
authorYves Senn <yves.senn@gmail.com>2015-04-28 14:34:51 +0200
committerYves Senn <yves.senn@gmail.com>2015-04-28 14:34:51 +0200
commit6ccf3bfa6e951fabf75352656a707f3a501b1cc2 (patch)
treec49e5f456d95a3577696d73446c33a18af91669e /guides/source
parent76fc205f9970208d597774095eccdaf07559803b (diff)
parent86b6c773378383c902c24b5b5917177bde4e8d62 (diff)
downloadrails-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')
-rw-r--r--guides/source/api_documentation_guidelines.md3
-rw-r--r--guides/source/ruby_on_rails_guides_guidelines.md6
2 files changed, 7 insertions, 2 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
diff --git a/guides/source/ruby_on_rails_guides_guidelines.md b/guides/source/ruby_on_rails_guides_guidelines.md
index 1323742488..50866350f8 100644
--- a/guides/source/ruby_on_rails_guides_guidelines.md
+++ b/guides/source/ruby_on_rails_guides_guidelines.md
@@ -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:
```