Skip to content

Update documentation for Elixir 1.20.1 and Phoenix 1.8.8 #2696

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.

Sign up for GitHub

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

Open
toupeira wants to merge 3 commits into
base: main
Choose a base branch
from
+163 −129
Open

Update documentation for Elixir 1.20.1 and Phoenix 1.8.8 #2696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
497f590
elixir: update HTML structure for section headings
toupeira Jun 13, 2026
1a8386f
Update Elixir documentation (1.20.1)
toupeira Jun 13, 2026
88880a8
Update Phoenix documentation (1.8.8)
toupeira Jun 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/docs/filters/elixir/clean_html.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def api
end
end

css('h1 a.icon-action[title="View Source"]').each do |node|
css('.top-heading a.icon-action[title="View Source"]').each do |node|
node['class'] = 'source'
node.content = "Source"
end
Expand Down
20 changes: 16 additions & 4 deletions lib/docs/filters/elixir/entries.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,31 @@ def get_name
end

def get_type
section = at_css('h1 a.source').attr('href').match('elixir/pages/([^/]+)/')&.captures&.first
# Use section titles for Elixir docs
section = at_css('.top-heading a.source')&.attr('href')&.match('elixir/pages/([^/]+)/')&.captures&.first
if section == "mix-and-otp"
return "Mix & OTP"
elsif section
return section.gsub("-", " ").capitalize
return section.gsub(/[-_]/, " ").capitalize
end

name = at_css('h1 span').text
# Use section titles for guides
guide = at_css('.top-heading a.source')&.attr('href')&.match('guides/(?:([^/]+)/)?')
if guide
section = guide.captures.first || "Guides"
return section.gsub(/[-_]/, " ").capitalize
end

# Sometimes the heading includes additional text in a <small> tag,
# in which case the main text is wrapped in a <span>
# e.g. https://elixir.hexdocs.pm/Exception.html
heading = at_css('.top-heading h1 span') || at_css('.top-heading h1')
name = heading.text
case name.split(' ').first
when 'mix' then 'Mix Tasks'
when 'Changelog' then 'References'
else
case at_css('h1 small').try(:content)
case at_css('.top-heading h1 small').try(:content)
when 'exception'
'Exceptions'
when 'protocol'
Expand Down
220 changes: 116 additions & 104 deletions lib/docs/scrapers/elixir.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,52 +17,64 @@ class Elixir < UrlScraper
options[:root_title] = 'Elixir'

options[:attribution] = <<-HTML
&copy; 2012-2024 The Elixir Team<br>
&copy; 2012-2026 The Elixir Team<br>
Licensed under the Apache License, Version 2.0.
HTML

def initial_urls
[ "https://hexdocs.pm/elixir/#{self.class.release}/introduction.html",
"https://hexdocs.pm/eex/#{self.class.release}/EEx.html",
"https://hexdocs.pm/ex_unit/#{self.class.release}/ExUnit.html",
"https://hexdocs.pm/iex/#{self.class.release}/IEx.html",
"https://hexdocs.pm/logger/#{self.class.release}/Logger.html",
"https://hexdocs.pm/mix/#{self.class.release}/Mix.html" ]
[ "https://elixir.hexdocs.pm/#{self.class.release}/introduction.html",
"https://eex.hexdocs.pm/#{self.class.release}/EEx.html",
"https://ex-unit.hexdocs.pm/#{self.class.release}/ExUnit.html",
"https://iex.hexdocs.pm/#{self.class.release}/IEx.html",
"https://logger.hexdocs.pm/#{self.class.release}/Logger.html",
"https://mix.hexdocs.pm/#{self.class.release}/Mix.html" ]
end

version '1.20' do
self.release = '1.20.1'
self.base_urls = [
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/"
]
end

version '1.18' do
self.release = '1.18.1'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/"
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/"
]
end

version '1.17' do
self.release = '1.17.2'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/"
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/"
]
end

version '1.16' do
self.release = '1.16.3'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/"
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/"
]
end

Expand All @@ -71,174 +83,174 @@ def initial_urls
version '1.15' do
self.release = '1.15.4'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.14' do
self.release = '1.14.1'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.13' do
self.release = '1.13.4'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.12' do
self.release = '1.12.0'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.11' do
self.release = '1.11.2'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.10' do
self.release = '1.10.4'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.9' do
self.release = '1.9.4'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.8' do
self.release = '1.8.2'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.7' do
self.release = '1.7.4'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.6' do
self.release = '1.6.6'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.5' do
self.release = '1.5.3'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.4' do
self.release = '1.4.5'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

version '1.3' do
self.release = '1.3.4'
self.base_urls = [
"https://hexdocs.pm/elixir/#{release}/",
"https://hexdocs.pm/eex/#{release}/",
"https://hexdocs.pm/ex_unit/#{release}/",
"https://hexdocs.pm/iex/#{release}/",
"https://hexdocs.pm/logger/#{release}/",
"https://hexdocs.pm/mix/#{release}/",
"https://elixir.hexdocs.pm/#{release}/",
"https://eex.hexdocs.pm/#{release}/",
"https://ex-unit.hexdocs.pm/#{release}/",
"https://iex.hexdocs.pm/#{release}/",
"https://logger.hexdocs.pm/#{release}/",
"https://mix.hexdocs.pm/#{release}/",
'https://elixir-lang.org/getting-started/'
]
end

def get_latest_version(opts)
doc = fetch_doc('https://hexdocs.pm/elixir/api-reference.html', opts)
doc = fetch_doc('https://elixir.hexdocs.pm/api-reference.html', opts)
doc.at_css('.sidebar-projectVersion').content.strip[1..-1]
end
end
Expand Down
Loading