Skip to content

Commit 42b12a6

Browse files
authored
docs: Generate Rails8 docs (#172)
* 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
1 parent a38bd38 commit 42b12a6

File tree

5,337 files changed

+508082
-13697
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

5,337 files changed

+508082
-13697
lines changed

Diff for: .github/workflows/ci.yml

+6-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737
with:
3838
submodules: true
3939
- name: fetch Rails tags
40-
run: cd rails && git fetch --depth=1 origin refs/tags/v7*:refs/tags/v7*
40+
run: cd rails && git fetch --depth=1 origin refs/tags/v8*:refs/tags/v8*
4141
- uses: ruby/setup-ruby@v1
4242
with:
4343
ruby-version: 3.3
@@ -48,11 +48,15 @@ jobs:
4848
doc-build-others:
4949
runs-on: ubuntu-latest
5050
name: Rails Doc Build (older versions)
51+
env:
52+
RUBY_YJIT_ENABLE: ${{ matrix.yjit-enabled }}
5153
strategy:
5254
matrix:
5355
include:
5456
- ruby-version: 2.7
55-
build-rails-versions: "5.2,6.0,6.1"
57+
build-rails-versions: "5.2"
58+
- ruby-version: 3.0
59+
build-rails-versions: "6.0,6.1"
5660
- ruby-version: 3.3
5761
build-rails-versions: "7.0,7.1,7.2"
5862
steps:

Diff for: _config.yml

+10-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@ title: RailsDoc(β)
22
description: Ruby on Rails API Documentation.
33
url: https://railsdoc.github.io
44
source: src
5-
default_rails_version: "7.2.2"
5+
default_rails_version: "8.0.0"
66
rails_versions:
7+
"8.0":
8+
specific_version: "8.0.0"
9+
latest: true
710
"7.2":
811
specific_version: "7.2.2"
9-
latest: true
1012
"7.1":
1113
specific_version: "7.1.5"
1214
"7.0":
@@ -31,10 +33,15 @@ defaults:
3133
- scope:
3234
path: ""
3335
values:
34-
version: 7.2
36+
version: 8.0
3537
image: https://avatars.githubusercontent.com/u/4223
3638
toc: true
3739
root_path: "/"
40+
- scope:
41+
path: "7.2"
42+
values:
43+
version: 7.2
44+
root_path: "/7.2/"
3845
- scope:
3946
path: "7.1"
4047
values:

Diff for: rails

Submodule rails updated 839 files

Diff for: src/7.2/classes/AbstractController.html

+126
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
title: AbstractController
3+
layout: default
4+
---
5+
<div class="main">
6+
<div class="banner">
7+
8+
<span>Ruby on Rails 7.2.2</span><br />
9+
10+
<div class="type">Module</div>
11+
<h1>
12+
AbstractController
13+
14+
</h1>
15+
<ul class="files">
16+
17+
<li><a href="../files/actionpack/lib/abstract_controller/asset_paths_rb.html">actionpack/lib/abstract_controller/asset_paths.rb</a></li>
18+
19+
<li><a href="../files/actionpack/lib/abstract_controller/base_rb.html">actionpack/lib/abstract_controller/base.rb</a></li>
20+
21+
<li><a href="../files/actionpack/lib/abstract_controller/caching_rb.html">actionpack/lib/abstract_controller/caching.rb</a></li>
22+
23+
<li><a href="../files/actionpack/lib/abstract_controller/caching/fragments_rb.html">actionpack/lib/abstract_controller/caching/fragments.rb</a></li>
24+
25+
<li><a href="../files/actionpack/lib/abstract_controller/callbacks_rb.html">actionpack/lib/abstract_controller/callbacks.rb</a></li>
26+
27+
<li><a href="../files/actionpack/lib/abstract_controller/collector_rb.html">actionpack/lib/abstract_controller/collector.rb</a></li>
28+
29+
<li><a href="../files/actionpack/lib/abstract_controller/deprecator_rb.html">actionpack/lib/abstract_controller/deprecator.rb</a></li>
30+
31+
<li><a href="../files/actionpack/lib/abstract_controller/error_rb.html">actionpack/lib/abstract_controller/error.rb</a></li>
32+
33+
<li><a href="../files/actionpack/lib/abstract_controller/helpers_rb.html">actionpack/lib/abstract_controller/helpers.rb</a></li>
34+
35+
<li><a href="../files/actionpack/lib/abstract_controller/logger_rb.html">actionpack/lib/abstract_controller/logger.rb</a></li>
36+
37+
<li><a href="../files/actionpack/lib/abstract_controller/railties/routes_helpers_rb.html">actionpack/lib/abstract_controller/railties/routes_helpers.rb</a></li>
38+
39+
<li><a href="../files/actionpack/lib/abstract_controller/rendering_rb.html">actionpack/lib/abstract_controller/rendering.rb</a></li>
40+
41+
<li><a href="../files/actionpack/lib/abstract_controller/translation_rb.html">actionpack/lib/abstract_controller/translation.rb</a></li>
42+
43+
<li><a href="../files/actionpack/lib/abstract_controller/url_for_rb.html">actionpack/lib/abstract_controller/url_for.rb</a></li>
44+
45+
<li><a href="../files/actionpack/lib/action_controller/metal/redirecting_rb.html">actionpack/lib/action_controller/metal/redirecting.rb</a></li>
46+
47+
<li><a href="../files/actionpack/lib/action_controller/metal/rendering_rb.html">actionpack/lib/action_controller/metal/rendering.rb</a></li>
48+
49+
<li><a href="../files/railties/lib/rails/engine_rb.html">railties/lib/rails/engine.rb</a></li>
50+
51+
<li><a href="../files/railties/lib/rails/mailers_controller_rb.html">railties/lib/rails/mailers_controller.rb</a></li>
52+
53+
</ul>
54+
</div>
55+
<div id="bodyContent">
56+
<div id="content">
57+
58+
59+
60+
61+
62+
63+
64+
65+
66+
<h2 id="namespace">Namespace</h2>
67+
68+
69+
<h3 id="module">Module</h3>
70+
<ul>
71+
72+
<li><a href="AbstractController/Caching.html">AbstractController::Caching</a></li>
73+
74+
<li><a href="AbstractController/Callbacks.html">AbstractController::Callbacks</a></li>
75+
76+
<li><a href="AbstractController/Collector.html">AbstractController::Collector</a></li>
77+
78+
<li><a href="AbstractController/Helpers.html">AbstractController::Helpers</a></li>
79+
80+
<li><a href="AbstractController/Railties.html">AbstractController::Railties</a></li>
81+
82+
<li><a href="AbstractController/Rendering.html">AbstractController::Rendering</a></li>
83+
84+
<li><a href="AbstractController/Translation.html">AbstractController::Translation</a></li>
85+
86+
<li><a href="AbstractController/UrlFor.html">AbstractController::UrlFor</a></li>
87+
88+
</ul>
89+
90+
91+
92+
<h3 id="class">Class</h3>
93+
<ul>
94+
95+
<li><a href="AbstractController/ActionNotFound.html">AbstractController::ActionNotFound</a></li>
96+
97+
<li><a href="AbstractController/Base.html">AbstractController::Base</a></li>
98+
99+
<li><a href="AbstractController/DoubleRenderError.html">AbstractController::DoubleRenderError</a></li>
100+
101+
</ul>
102+
103+
104+
105+
106+
107+
108+
109+
110+
111+
112+
113+
114+
115+
116+
117+
118+
<!-- Methods -->
119+
120+
121+
122+
123+
</div>
124+
125+
</div>
126+
</div>
+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: AbstractController::ActionNotFound
3+
layout: default
4+
---
5+
<div class="main">
6+
<div class="banner">
7+
8+
<span>Ruby on Rails 7.2.2</span><br />
9+
10+
<div class="type">Class</div>
11+
<h1>
12+
AbstractController::ActionNotFound
13+
14+
<span class="parent">&lt;
15+
16+
StandardError
17+
18+
</span>
19+
20+
</h1>
21+
<ul class="files">
22+
23+
<li><a href="../../files/actionpack/lib/abstract_controller/base_rb.html">actionpack/lib/abstract_controller/base.rb</a></li>
24+
25+
</ul>
26+
</div>
27+
<div id="bodyContent">
28+
<div id="content">
29+
30+
<div class="description">
31+
32+
<p>Raised when a non-existing controller action is triggered.</p>
33+
34+
</div>
35+
36+
37+
38+
39+
40+
41+
42+
43+
44+
45+
46+
47+
48+
49+
50+
51+
52+
53+
54+
55+
56+
57+
58+
<!-- Methods -->
59+
60+
61+
62+
63+
</div>
64+
65+
</div>
66+
</div>

0 commit comments

Comments
 (0)