Skip to content

Commit

Permalink
docs: Generate Rails8 docs (#172)
Browse files Browse the repository at this point in the history
* feat: Configure for Rails v8

* Use rails v8 submodule

* ci: Fetch Rails v8 tags

* docs: Generate Rails v7.2 docs

* ci: Enable YJIT and separated older builds

* docs: Generate Rails v8 docs
  • Loading branch information
toshimaru authored Nov 24, 2024
1 parent a38bd38 commit 42b12a6
Show file tree
Hide file tree
Showing 5,337 changed files with 508,082 additions and 13,697 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
8 changes: 6 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
with:
submodules: true
- name: fetch Rails tags
run: cd rails && git fetch --depth=1 origin refs/tags/v7*:refs/tags/v7*
run: cd rails && git fetch --depth=1 origin refs/tags/v8*:refs/tags/v8*
- uses: ruby/setup-ruby@v1
with:
ruby-version: 3.3
Expand All @@ -48,11 +48,15 @@ jobs:
doc-build-others:
runs-on: ubuntu-latest
name: Rails Doc Build (older versions)
env:
RUBY_YJIT_ENABLE: ${{ matrix.yjit-enabled }}
strategy:
matrix:
include:
- ruby-version: 2.7
build-rails-versions: "5.2,6.0,6.1"
build-rails-versions: "5.2"
- ruby-version: 3.0
build-rails-versions: "6.0,6.1"
- ruby-version: 3.3
build-rails-versions: "7.0,7.1,7.2"
steps:
Expand Down
13 changes: 10 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ title: RailsDoc(β)
description: Ruby on Rails API Documentation.
url: https://railsdoc.github.io
source: src
default_rails_version: "7.2.2"
default_rails_version: "8.0.0"
rails_versions:
"8.0":
specific_version: "8.0.0"
latest: true
"7.2":
specific_version: "7.2.2"
latest: true
"7.1":
specific_version: "7.1.5"
"7.0":
Expand All @@ -31,10 +33,15 @@ defaults:
- scope:
path: ""
values:
version: 7.2
version: 8.0
image: https://avatars.githubusercontent.com/u/4223
toc: true
root_path: "/"
- scope:
path: "7.2"
values:
version: 7.2
root_path: "/7.2/"
- scope:
path: "7.1"
values:
Expand Down
2 changes: 1 addition & 1 deletion rails
Submodule rails updated 839 files
126 changes: 126 additions & 0 deletions src/7.2/classes/AbstractController.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
---
title: AbstractController
layout: default
---
<div class="main">
<div class="banner">

<span>Ruby on Rails 7.2.2</span><br />

<div class="type">Module</div>
<h1>
AbstractController

</h1>
<ul class="files">

<li><a href="../files/actionpack/lib/abstract_controller/asset_paths_rb.html">actionpack/lib/abstract_controller/asset_paths.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/base_rb.html">actionpack/lib/abstract_controller/base.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/caching_rb.html">actionpack/lib/abstract_controller/caching.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/caching/fragments_rb.html">actionpack/lib/abstract_controller/caching/fragments.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/callbacks_rb.html">actionpack/lib/abstract_controller/callbacks.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/collector_rb.html">actionpack/lib/abstract_controller/collector.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/deprecator_rb.html">actionpack/lib/abstract_controller/deprecator.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/error_rb.html">actionpack/lib/abstract_controller/error.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/helpers_rb.html">actionpack/lib/abstract_controller/helpers.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/logger_rb.html">actionpack/lib/abstract_controller/logger.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/railties/routes_helpers_rb.html">actionpack/lib/abstract_controller/railties/routes_helpers.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/rendering_rb.html">actionpack/lib/abstract_controller/rendering.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/translation_rb.html">actionpack/lib/abstract_controller/translation.rb</a></li>

<li><a href="../files/actionpack/lib/abstract_controller/url_for_rb.html">actionpack/lib/abstract_controller/url_for.rb</a></li>

<li><a href="../files/actionpack/lib/action_controller/metal/redirecting_rb.html">actionpack/lib/action_controller/metal/redirecting.rb</a></li>

<li><a href="../files/actionpack/lib/action_controller/metal/rendering_rb.html">actionpack/lib/action_controller/metal/rendering.rb</a></li>

<li><a href="../files/railties/lib/rails/engine_rb.html">railties/lib/rails/engine.rb</a></li>

<li><a href="../files/railties/lib/rails/mailers_controller_rb.html">railties/lib/rails/mailers_controller.rb</a></li>

</ul>
</div>
<div id="bodyContent">
<div id="content">









<h2 id="namespace">Namespace</h2>


<h3 id="module">Module</h3>
<ul>

<li><a href="AbstractController/Caching.html">AbstractController::Caching</a></li>

<li><a href="AbstractController/Callbacks.html">AbstractController::Callbacks</a></li>

<li><a href="AbstractController/Collector.html">AbstractController::Collector</a></li>

<li><a href="AbstractController/Helpers.html">AbstractController::Helpers</a></li>

<li><a href="AbstractController/Railties.html">AbstractController::Railties</a></li>

<li><a href="AbstractController/Rendering.html">AbstractController::Rendering</a></li>

<li><a href="AbstractController/Translation.html">AbstractController::Translation</a></li>

<li><a href="AbstractController/UrlFor.html">AbstractController::UrlFor</a></li>

</ul>



<h3 id="class">Class</h3>
<ul>

<li><a href="AbstractController/ActionNotFound.html">AbstractController::ActionNotFound</a></li>

<li><a href="AbstractController/Base.html">AbstractController::Base</a></li>

<li><a href="AbstractController/DoubleRenderError.html">AbstractController::DoubleRenderError</a></li>

</ul>
















<!-- Methods -->




</div>

</div>
</div>
66 changes: 66 additions & 0 deletions src/7.2/classes/AbstractController/ActionNotFound.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: AbstractController::ActionNotFound
layout: default
---
<div class="main">
<div class="banner">

<span>Ruby on Rails 7.2.2</span><br />

<div class="type">Class</div>
<h1>
AbstractController::ActionNotFound

<span class="parent">&lt;

StandardError

</span>

</h1>
<ul class="files">

<li><a href="../../files/actionpack/lib/abstract_controller/base_rb.html">actionpack/lib/abstract_controller/base.rb</a></li>

</ul>
</div>
<div id="bodyContent">
<div id="content">

<div class="description">

<p>Raised when a non-existing controller action is triggered.</p>

</div>























<!-- Methods -->




</div>

</div>
</div>
Loading

0 comments on commit 42b12a6

Please sign in to comment.