| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| | |
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
Since Active Support is monkey patching a lot of core classes, let's
rather document these changes under a new section so they are still
documented but not encumbering the sidebar.
We can safely remove the rescuing of the `LoadError` since as of
cd7cc525, it's not possible to generate the API from an application.
[ci skip]
[Kasper Timm Hansen & Robin Dupret]
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
There are a lot of monkey patches inside the code base but there's
no need to document external constants so let's remove them from
the documentation
Also, since there are monkey patches for some test cases classes,
there were sometimes both documented and sneaked under the wrong
section in the sidebar.
Finally, for future references, the `active_support/vendor`
folder has been originally ignored in https://git.io/vDqfA but
no longer exists.
[ci skip]
|
| | |
|
| |
|
|
|
| |
The current code base is not uniform. After some discussion,
we have chosen to go with double quotes by default.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
Only include files that contain changes since the last generation
of the API documentation.
Thus, only modified files are re-generated instead of the whole API.
The `created.rid` file won't contain the whole list of files anymore
if we generate several times the API but we don't really care about it,
only the generation date and time is important.
It is possible to fall back to the previous behavior by defining the ALL
environment variable running the `rake rdoc` task.
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
| | |
|
| |
|
|
|
|
| |
1. As we have vendor in AV only
2. No more vendor in AC
3. No vendor folder in AR
|
| |
|
|
|
|
|
| |
This reverts commit 70d6e16fbad75b89dd1798ed697e7732b8606fa3, reversing
changes made to ea4db3bc078fb3093ecdddffdf4f2f4ff3e1e8f9.
Seems to be a code merge done by mistake.
|
| |
|
|
| |
These folder not exists in system
|
| | |
|
| |
|
| |
CHANGELOG and LICENSE removed as suggested
|
| | |
|
| | |
|
| |
|
|
|
| |
Do the absolute bare minimum needed to define this task, no need to compute
gem paths everytime you call rake.
|
| |
|
|
|
| |
This code is executed every time you run a rake task, there is no need to, specially
adding a penalty to test suites.
|
| | |
|
| | |
|
| | |
|
| |
|
|
|
|
| |
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.
|
| |
|
