aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails/api
Commit message (Collapse)AuthorAgeFilesLines
* Generate API doc for actioncableArun Agrawal2015-12-171-0/+7
|
* Remove documentation tasksXavier Noria2015-02-061-14/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch removes the tasks doc:app, doc:rails, and doc:guides. In our experience applications do not generate APIs using doc:app. Methods may be certainly documented for maintainers, annotated with YARD tags, etc. but that is intended to be read with the source code, not in a separate website. Then, teams also have typically selected topics written down in Markdown files, or in a GitHub wiki... that kind of thing. If a team absolutely needs to generate application documentation for internal purposes, they can still easily write their own task. Regarding doc:rails and doc:guides, we live in 2015. We are used to go to online docs all the time. If you really want access to the API offline RubyGems generates it for every Rails component unless you tell it not to, and you can checkout the Rails source code to read the guides as Markdown, or download them for a Kindle reader. All in all, maintaining this code does not seem to be worthwhile anymore. As a consequence of this, guides (+3 MB uncompressed) won't be distributed with the rails gem anymore. Of course, guides and API are going to be still part of releases, since documentation is maintained alongside code and tests. Also, time permitting, this will allow us to experiment with novel ways to generate documentation in the Rails docs server, since right now we were constrained by being able to generate them in the user's environment.
* Added docs for AJ::Callbacks; Added AJ to docs build mapCristian Bica2014-08-161-0/+7
|
* Fixed API task fileArun Agrawal2013-09-091-7/+5
| | | | | | 1. As we have vendor in AV only 2. No more vendor in AC 3. No vendor folder in AR
* Revert "Merge branch 'master' of github.com:rails/docrails"Vijay Dev2013-08-171-5/+7
| | | | | | | This reverts commit 70d6e16fbad75b89dd1798ed697e7732b8606fa3, reversing changes made to ea4db3bc078fb3093ecdddffdf4f2f4ff3e1e8f9. Seems to be a code merge done by mistake.
* Removed excluding vendor from API doc [ci skip]Arun Agrawal2013-07-261-6/+3
| | | | These folder not exists in system
* Excluding action_view/vendor in API [ci skip]Arun Agrawal2013-07-261-1/+2
|
* Added actionview in API generation [ci skip]Arun Agrawal2013-07-141-8/+7
| | | CHANGELOG and LICENSE removed as suggested
* fixes Rails version for the stable API [ci skip]Xavier Noria2013-07-061-0/+8
|
* Exclude template files for rdoc API [ci skip]Francesco Rodriguez2013-04-041-1/+2
|
* configure API generation lazilyXavier Noria2013-03-301-7/+11
| | | | | Do the absolute bare minimum needed to define this task, no need to compute gem paths everytime you call rake.
* be lazy configuring the RDoc filesXavier Noria2013-03-301-2/+1
| | | | | This code is executed every time you run a rake task, there is no need to, specially adding a penalty to test suites.
* be lazy loading SDocXavier Noria2013-03-301-4/+11
|
* typoXavier Noria2013-03-301-1/+1
|
* unifies API generationXavier Noria2013-03-301-7/+32
|
* moves RDOC_MAIN.rdoc to railtiesXavier Noria2013-03-301-1/+1
| | | | | | The goal of these refactors is to have the same code generating edge and doc:rails APIs, and the rails gem is not available in LOAD_PATHS because it has no lib directory.
* encapsulates API generation in Rails::API::TaskXavier Noria2013-03-301-0/+122
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-28 15:51:18 +0000