Skip to content

Generate docs for Rails v7.1.3 / Build pages with Ruby v3.3 + YJIT on CI #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
76 changes: 47 additions & 29 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,42 +7,60 @@ jobs:
runs-on: ubuntu-latest
name: Jekyll Build
steps:
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
ruby-version: 3.2
bundler-cache: true
- name: Jekyll Build
run: bundle exec jekyll build
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
ruby-version: 3.3
bundler-cache: true
- name: Jekyll Build
run: bundle exec jekyll build

doc-build-latest:
runs-on: ubuntu-latest
name: Rails Doc Build (latest)
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: fetch Rails tags
run: cd rails && git fetch --depth=1 origin refs/tags/v7*:refs/tags/v7*
- uses: ruby/setup-ruby@v1
with:
ruby-version: 3.2
bundler-cache: true
- name: Doc Build
run: rake build
- uses: actions/checkout@v4
with:
submodules: true
- name: fetch Rails tags
run: cd rails && git fetch --depth=1 origin refs/tags/v7*:refs/tags/v7*
- uses: ruby/setup-ruby@v1
with:
ruby-version: 3.3
bundler-cache: true
- name: Doc Build
run: rake build

doc-build-latest-with-yjit:
runs-on: ubuntu-latest
name: Rails Doc Build (latest, with YJIT enabled)
env:
RUBY_YJIT_ENABLE: true
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: fetch Rails tags
run: cd rails && git fetch --depth=1 origin refs/tags/v7*:refs/tags/v7*
- uses: ruby/setup-ruby@v1
with:
ruby-version: 3.3
bundler-cache: true
- name: Doc Build
run: rake build

doc-build-others:
runs-on: ubuntu-latest
name: Rails Doc Build (older versions)
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: fetch Rails tags
run: cd rails && git fetch --depth=1 origin refs/tags/v7*:refs/tags/v7* refs/tags/v6*:refs/tags/v6* refs/tags/v5*:refs/tags/v5*
- uses: ruby/setup-ruby@v1
with:
ruby-version: 2.7
bundler-cache: true
- name: Doc Build
run: rake build_multi
- uses: actions/checkout@v4
with:
submodules: true
- name: fetch Rails tags
run: cd rails && git fetch --depth=1 origin refs/tags/v7*:refs/tags/v7* refs/tags/v6*:refs/tags/v6* refs/tags/v5*:refs/tags/v5*
- uses: ruby/setup-ruby@v1
with:
ruby-version: 2.7
bundler-cache: true
- name: Doc Build
run: rake build_multi
30 changes: 14 additions & 16 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (7.1.3.2)
activesupport (7.1.3.4)
base64
bigdecimal
concurrent-ruby (~> 1.0, >= 1.0.2)
Expand All @@ -11,17 +11,17 @@ GEM
minitest (>= 5.1)
mutex_m
tzinfo (~> 2.0)
addressable (2.8.6)
public_suffix (>= 2.0.2, < 6.0)
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
base64 (0.2.0)
bigdecimal (3.1.7)
bigdecimal (3.1.8)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.12.2)
colorator (1.1.0)
commonmarker (0.23.10)
concurrent-ruby (1.2.3)
concurrent-ruby (1.3.3)
connection_pool (2.4.1)
dnsruby (1.72.1)
simpleidn (~> 0.2.1)
Expand All @@ -38,7 +38,8 @@ GEM
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2)
ffi (1.16.3)
ffi (1.17.0)
ffi (1.17.0-arm64-darwin)
forwardable-extended (2.6.0)
gemoji (4.1.0)
github-pages (231)
Expand Down Expand Up @@ -218,12 +219,12 @@ GEM
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
mini_portile2 (2.8.6)
mini_portile2 (2.8.7)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.22.3)
minitest (5.24.1)
mutex_m (0.2.0)
nokogiri (1.15.6)
mini_portile2 (~> 2.8.2)
Expand All @@ -233,14 +234,14 @@ GEM
sawyer (~> 0.9)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.5)
public_suffix (5.1.1)
racc (1.8.0)
rake (13.2.1)
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
rexml (3.2.8)
strscan (>= 3.0.9)
rexml (3.3.1)
strscan
rouge (3.30.0)
ruby2_keywords (0.0.5)
rubyzip (2.3.2)
Expand All @@ -253,22 +254,19 @@ GEM
sawyer (0.9.2)
addressable (>= 2.3.5)
faraday (>= 0.17.3, < 3)
simpleidn (0.2.1)
unf (~> 0.1.4)
simpleidn (0.2.3)
strscan (3.1.0)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
typhoeus (1.4.1)
ethon (>= 0.9.0)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
unf (0.1.4)
unf_ext
unf_ext (0.0.9.1)
unicode-display_width (1.8.0)
webrick (1.8.1)

PLATFORMS
arm64-darwin-23
ruby

DEPENDENCIES
Expand Down
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ title: RailsDoc(β)
description: Ruby on Rails API Documentation.
url: https://railsdoc.github.io
source: src
default_rails_version: '7.1.0'
default_rails_version: '7.1.3'
rails_versions:
"7.1":
specific_version: "7.1.0"
specific_version: "7.1.3"
latest: true
"7.0":
specific_version: "7.0.8"
Expand Down
8 changes: 8 additions & 0 deletions compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
services:
app:
image: ruby:3.3
working_dir: /app
volumes:
- .:/app
environment:
RUBY_YJIT_ENABLE: true
2 changes: 1 addition & 1 deletion rails
Submodule rails updated 417 files
2 changes: 1 addition & 1 deletion src/classes/AbstractController.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<div class="main">
<div class="banner">

<span>Ruby on Rails 7.1.0</span><br />
<span>Ruby on Rails 7.1.3</span><br />

<div class="type">Module</div>
<h1>
Expand Down
2 changes: 1 addition & 1 deletion src/classes/AbstractController/ActionNotFound.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<div class="main">
<div class="banner">

<span>Ruby on Rails 7.1.0</span><br />
<span>Ruby on Rails 7.1.3</span><br />

<div class="type">Class</div>
<h1>
Expand Down
38 changes: 19 additions & 19 deletions src/classes/AbstractController/Base.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<div class="main">
<div class="banner">

<span>Ruby on Rails 7.1.0</span><br />
<span>Ruby on Rails 7.1.3</span><br />

<div class="type">Class</div>
<h1>
Expand Down Expand Up @@ -73,11 +73,11 @@ <h2 id="methods">Methods</h2>
</li>

<li>
<a href="#method-i-controller_path">controller_path</a>
<a href="#method-c-controller_path">controller_path</a>
</li>

<li>
<a href="#method-c-controller_path">controller_path</a>
<a href="#method-i-controller_path">controller_path</a>
</li>

<li>
Expand Down Expand Up @@ -191,7 +191,7 @@ <h3 id="method-c-abstract-21">
@abstract = true
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L57" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L57" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -239,7 +239,7 @@ <h4 id="method-c-action_methods-label-Returns">Returns</h4>
end
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L96" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L96" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -274,7 +274,7 @@ <h3 id="method-c-clear_action_methods-21">
@action_methods = nil
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L111" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L111" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -321,7 +321,7 @@ <h4 id="method-c-controller_path-label-Returns">Returns</h4>
@controller_path ||= name.delete_suffix(&quot;Controller&quot;).underscore unless anonymous?
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L125" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L125" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -364,7 +364,7 @@ <h3 id="method-c-internal_methods">
controller.public_instance_methods(true) - methods
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L76" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L76" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -400,7 +400,7 @@ <h3 id="method-c-method_added">
clear_action_methods!
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L130" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L130" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -435,7 +435,7 @@ <h3 id="method-c-supports_path-3F">
true
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L199" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L199" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -474,7 +474,7 @@ <h3 id="method-i-action_methods">
self.class.action_methods
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L170" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L170" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -508,7 +508,7 @@ <h3 id="method-i-action_name">
attr_internal :action_name
</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L42" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L42" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -550,7 +550,7 @@ <h4 id="method-i-available_action-3F-label-Parameters">Parameters</h4>
_find_action_name(action_name)
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L184" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L184" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -585,7 +585,7 @@ <h3 id="method-i-controller_path">
self.class.controller_path
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L165" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L165" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -619,7 +619,7 @@ <h3 id="method-i-formats">
attr_internal :formats
</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L46" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L46" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -654,7 +654,7 @@ <h3 id="method-i-performed-3F">
response_body
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L191" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L191" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand All @@ -669,7 +669,7 @@ <h3 id="method-i-process">


<div class="description">
<p>Calls the action going through the entire action dispatch stack.</p>
<p>Calls the action going through the entire Action Dispatch stack.</p>

<p>The actual method that is called is determined by calling method_for_action. If no method can handle the action, then an <a href="ActionNotFound.html"><code>AbstractController::ActionNotFound</code></a> error is raised.</p>

Expand Down Expand Up @@ -704,7 +704,7 @@ <h4 id="method-i-process-label-Returns">Returns</h4>
process_action(action_name, *args)
end</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L151" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L151" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down Expand Up @@ -738,7 +738,7 @@ <h3 id="method-i-response_body">
attr_internal :response_body
</code></pre>

<a href="https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/actionpack/lib/abstract_controller/base.rb#L38" target="_blank" class="github_url">🔎 See on GitHub</a>
<a href="https://github.com/rails/rails/blob/36c1591bcb5e0ee3084759c7f42a706fe5bb7ca7/actionpack/lib/abstract_controller/base.rb#L38" target="_blank" class="github_url">🔎 See on GitHub</a>

</details>

Expand Down
Loading