1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Commit graph

17 commits

Author SHA1 Message Date
Arun Agrawal
5659b86d70 Generate API doc for actioncable 2015-12-17 16:04:46 +01:00
Xavier Noria
cd7cc5254b Remove documentation tasks
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.
2015-02-06 21:04:54 +01:00
Cristian Bica
b2cabb7ace Added docs for AJ::Callbacks; Added AJ to docs build map 2014-08-16 01:31:39 +03:00
Arun Agrawal
047b187d0e Fixed API task file
1. As we have vendor in AV only
2. No more vendor in AC
3. No vendor folder in AR
2013-09-09 17:04:04 +02:00
Vijay Dev
ec8ef1e105 Revert "Merge branch 'master' of github.com:rails/docrails"
This reverts commit 70d6e16fba, reversing
changes made to ea4db3bc07.

Seems to be a code merge done by mistake.
2013-08-17 21:46:39 +05:30
Arun Agrawal
1e384f82b0 Removed excluding vendor from API doc [ci skip]
These folder not exists in system
2013-07-26 12:21:53 +02:00
Arun Agrawal
e32576ae52 Excluding action_view/vendor in API [ci skip] 2013-07-26 12:03:53 +02:00
Arun Agrawal
d4e1fcf7e5 Added actionview in API generation [ci skip]
CHANGELOG and LICENSE removed as suggested
2013-07-14 09:44:58 +02:00
Xavier Noria
374fd6693a fixes Rails version for the stable API [ci skip] 2013-07-06 22:42:24 +02:00
Francesco Rodriguez
a77ad86ff1 Exclude template files for rdoc API [ci skip] 2013-04-04 17:28:44 -05:00
Xavier Noria
92d6dacc34 configure API generation lazily
Do the absolute bare minimum needed to define this task, no need to compute
gem paths everytime you call rake.
2013-03-30 11:34:35 +01:00
Xavier Noria
2645f6844f be lazy configuring the RDoc files
This code is executed every time you run a rake task, there is no need to, specially
adding a penalty to test suites.
2013-03-30 11:34:35 +01:00
Xavier Noria
f01b7570c5 be lazy loading SDoc 2013-03-30 11:34:35 +01:00
Xavier Noria
4ecf1f8724 typo 2013-03-30 00:38:59 +01:00
Xavier Noria
84c0ac3b56 unifies API generation 2013-03-30 00:10:52 +01:00
Xavier Noria
3235537030 moves RDOC_MAIN.rdoc to railties
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.
2013-03-30 00:10:52 +01:00
Xavier Noria
7a5aa720c4 encapsulates API generation in Rails::API::Task 2013-03-30 00:10:52 +01:00