diff options
| author | Zachary Scott <e@zzak.io> | 2014-06-13 10:10:43 -0700 |
|---|---|---|
| committer | Zachary Scott <e@zzak.io> | 2014-06-13 10:10:43 -0700 |
| commit | f12d6367adb48acd47397662fdee94f2270749cc (patch) | |
| tree | a956dccf126e71ce3b9f4edacb8db27904a37580 /guides/source/api_documentation_guidelines.md | |
| parent | faf0a93df56d00eb0956748780838321911fc655 (diff) | |
| download | rails-f12d6367adb48acd47397662fdee94f2270749cc.tar.gz rails-f12d6367adb48acd47397662fdee94f2270749cc.tar.bz2 rails-f12d6367adb48acd47397662fdee94f2270749cc.zip | |
Add links to RDoc back into API documentation guidelines [ci skip]
These were removed from #15542 unfortunately :(
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 dda9baa8d7..2b6a9f61eb 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/guides/source/api_documentation_guidelines.md @@ -13,7 +13,8 @@ After reading this guide, you will know: RDoc ---- -The [Rails API documentation](http://api.rubyonrails.org) is generated with RDoc. +The [Rails API documentation](http://api.rubyonrails.org) is generated with +[RDoc](http://docs.seattlerb.org/rdoc/). ```bash bundle exec rake rdoc @@ -21,6 +22,11 @@ The [Rails API documentation](http://api.rubyonrails.org) is generated with RDoc Resulting HTML files can be found in the ./doc/rdoc directory. +Please consult the RDoc documentation for help with the +[markup](http://docs.seattlerb.org/rdoc/RDoc/Markup.html), +and also take into account these [additional +directives](http://docs.seattlerb.org/rdoc/RDoc/Parser/Ruby.html). + Wording ------- |