github
/
ruby
зеркало из https://github.com/github/ruby.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Sync rdoc

This commit is contained in:
Stan Lo 2024-08-03 11:29:40 +01:00 коммит произвёл Hiroshi SHIBATA
Родитель 7d5cb4573d
Коммит cbc40bb130
15 изменённых файлов: 115 добавлений и 36 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

1
lib/rdoc/generator/template/darkfish/_head.rhtml
Просмотреть файл

@ -1,4 +1,5 @@
<meta charset="<%= @options.charset %>"> <meta charset="<%= @options.charset %>">
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title><%= h @title %></title> <title><%= h @title %></title>

3
lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml Normal file
Просмотреть файл

@ -0,0 +1,3 @@
<button id="navigation-toggle" class="navigation-toggle" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
<span aria-hidden>☰</span>
</button>

4
lib/rdoc/generator/template/darkfish/class.rhtml
Просмотреть файл

@ -1,5 +1,7 @@
<body id="top" role="document" class="<%= klass.type %>"> <body id="top" role="document" class="<%= klass.type %>">
<nav role="navigation"> <%= render '_sidebar_toggle.rhtml' %>
<nav id="navigation" role="navigation">
<div id="project-navigation"> <div id="project-navigation">
<%= render '_sidebar_navigation.rhtml' %> <%= render '_sidebar_navigation.rhtml' %>
<%= render '_sidebar_search.rhtml' %> <%= render '_sidebar_search.rhtml' %>

75
lib/rdoc/generator/template/darkfish/css/rdoc.css
Просмотреть файл

@ -19,12 +19,12 @@ body {
font-weight: 300; font-weight: 300;
/* Layout */ /* Layout */
display: grid; display: flex;
grid-template-columns: auto 1fr; flex-wrap: wrap;
} }
body > :last-child { body > :last-child {
grid-column: 1 / 3; width: 100%;
} }
h1 span, h1 span,
@ -203,24 +203,38 @@ nav {
font-family: Helvetica, sans-serif; font-family: Helvetica, sans-serif;
font-size: 14px; font-size: 14px;
border-right: 1px solid #ccc; border-right: 1px solid #ccc;
position: sticky; position: fixed;
top: 0; top: 0;
overflow: auto; overflow: auto;
z-index: 10;
/* Layout */ /* Layout */
width: 260px; /* fallback */ width: 300px;
width: max(50px, 20vw); min-height: 100vh;
min-width: 50px; background: white;
max-width: 80vw; }
height: calc(100vh - 100px); /* reduce the footer height */
resize: horizontal; @media (min-width: 1024px) {
nav {
min-height: unset;
height: calc(100vh - 100px); /* reduce the footer height */
}
} }
main { main {
display: block; display: block;
margin: 1em; margin: 3em 1em 1em;
min-width: 340px; min-width: 340px;
font-size: 16px; font-size: 16px;
width: 100%;
max-width: 64em;
}
@media (min-width: 1024px) {
main {
margin-left: auto;
margin-right: auto;
}
} }
main h1, main h1,
@ -232,8 +246,10 @@ main h6 {
font-family: Helvetica, sans-serif; font-family: Helvetica, sans-serif;
} }
.table-of-contents main { @media (min-width: 1024px) {
margin-left: 2em; .table-of-contents main {
margin-left: 20em;
}
} }
#validator-badges { #validator-badges {
@ -280,6 +296,38 @@ nav p {
list-style: none; list-style: none;
} }
.navigation-toggle {
position: fixed;
left: 4px;
z-index: 100;
background: transparent;
border: none;
cursor: pointer;
padding: 4px;
font-size: 24px;
}
.navigation-toggle[aria-expanded="true"] {
left: 260px;
}
/* Adds a suble gradient to help the toggle stand out from the background */
.navigation-toggle::before {
content: "";
background: linear-gradient(180deg, rgba(250,250,250,1) 40%, rgba(250,250,250,0.8) 70%, rgba(250,250,250,0) 100%);
display: block;
z-index: -1;
pointer-events: none;
position: fixed;
top: 0;
height: 50px;
width: 100vw;
}
.navigation-toggle[aria-expanded="true"]::before {
height: 0;
}
#project-navigation .nav-section { #project-navigation .nav-section {
margin: 0; margin: 0;
border-top: 0; border-top: 0;
@ -684,4 +732,3 @@ pre {
} }
/* @end */ /* @end */

4
lib/rdoc/generator/template/darkfish/index.rhtml
Просмотреть файл

@ -1,5 +1,7 @@
<body id="top" role="document" class="file"> <body id="top" role="document" class="file">
<nav role="navigation"> <%= render '_sidebar_toggle.rhtml' %>
<nav id="navigation" role="navigation">
<div id="project-navigation"> <div id="project-navigation">
<%= render '_sidebar_navigation.rhtml' %> <%= render '_sidebar_navigation.rhtml' %>

17
lib/rdoc/generator/template/darkfish/js/darkfish.js
Просмотреть файл

@ -90,8 +90,25 @@ function hookFocus() {
}); });
} }
function hookSidebar() {
var navigation = document.querySelector('#navigation');
var navigationToggle = document.querySelector('#navigation-toggle');
navigationToggle.addEventListener('click', function() {
navigation.hidden = !navigation.hidden;
navigationToggle.ariaExpanded = navigationToggle.ariaExpanded !== 'true';
});
var isSmallViewport = window.matchMedia("(max-width: 1024px)").matches;
if (isSmallViewport) {
navigation.hidden = true;
navigationToggle.ariaExpanded = false;
}
}
document.addEventListener('DOMContentLoaded', function() { document.addEventListener('DOMContentLoaded', function() {
hookSourceViews(); hookSourceViews();
hookSearch(); hookSearch();
hookFocus(); hookFocus();
hookSidebar();
}); });

5
lib/rdoc/generator/template/darkfish/page.rhtml
Просмотреть файл

@ -1,5 +1,7 @@
<body id="top" role="document" class="file"> <body id="top" role="document" class="file">
<nav role="navigation"> <%= render '_sidebar_toggle.rhtml' %>
<nav id="navigation" role="navigation">
<div id="project-navigation"> <div id="project-navigation">
<%= render '_sidebar_navigation.rhtml' %> <%= render '_sidebar_navigation.rhtml' %>
<%= render '_sidebar_search.rhtml' %> <%= render '_sidebar_search.rhtml' %>
@ -15,4 +17,3 @@
<main role="main" aria-label="Page <%=h file.full_name%>"> <main role="main" aria-label="Page <%=h file.full_name%>">
<%= file.description %> <%= file.description %>
</main> </main>

5
lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
Просмотреть файл

@ -1,5 +1,7 @@
<body role="document"> <body role="document">
<nav role="navigation"> <%= render '_sidebar_toggle.rhtml' %>
<nav id="navigation" role="navigation">
<%= render '_sidebar_navigation.rhtml' %> <%= render '_sidebar_navigation.rhtml' %>
<%= render '_sidebar_search.rhtml' %> <%= render '_sidebar_search.rhtml' %>
@ -15,4 +17,3 @@
<p><%= message %> <p><%= message %>
</main> </main>

4
lib/rdoc/generator/template/darkfish/servlet_root.rhtml
Просмотреть файл

@ -1,5 +1,7 @@
<body role="document"> <body role="document">
<nav role="navigation"> <%= render '_sidebar_toggle.rhtml' %>
<nav id="navigation" role="navigation">
<div id="project-navigation"> <div id="project-navigation">
<div id="home-section" class="nav-section"> <div id="home-section" class="nav-section">
<h2> <h2>

9
lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
Просмотреть файл

@ -1,4 +1,13 @@
<body id="top" class="table-of-contents"> <body id="top" class="table-of-contents">
<%= render '_sidebar_toggle.rhtml' %>
<nav id="navigation" role="navigation">
<div id="project-navigation">
<%= render '_sidebar_navigation.rhtml' %>
<%= render '_sidebar_search.rhtml' %>
</div>
</nav>
<main role="main"> <main role="main">
<h1 class="class"><%= h @title %></h1> <h1 class="class"><%= h @title %></h1>

3
lib/rdoc/parser/ruby.rb
Просмотреть файл

@ -11,6 +11,9 @@
if ENV['RDOC_USE_PRISM_PARSER'] if ENV['RDOC_USE_PRISM_PARSER']
require 'rdoc/parser/prism_ruby' require 'rdoc/parser/prism_ruby'
RDoc::Parser.const_set(:Ruby, RDoc::Parser::PrismRuby) RDoc::Parser.const_set(:Ruby, RDoc::Parser::PrismRuby)
puts "========================================================================="
puts "RDoc is using the experimental Prism parser to generate the documentation"
puts "========================================================================="
return return
end end

8
lib/rdoc/rd/block_parser.rb
Просмотреть файл

@ -1,7 +1,7 @@
# frozen_string_literal: true # frozen_string_literal: true
# #
# DO NOT MODIFY!!!! # DO NOT MODIFY!!!!
# This file is automatically generated by Racc 1.7.3 # This file is automatically generated by Racc 1.8.0
# from Racc grammar file "block_parser.ry". # from Racc grammar file "block_parser.ry".
# #
@ -23,7 +23,7 @@ unless $".find {|p| p.end_with?('/racc/info.rb')}
$".push "#{__dir__}/racc/info.rb" $".push "#{__dir__}/racc/info.rb"
module Racc module Racc
VERSION = '1.7.3' VERSION = '1.8.0'
Version = VERSION Version = VERSION
Copyright = 'Copyright (c) 1999-2006 Minero Aoki' Copyright = 'Copyright (c) 1999-2006 Minero Aoki'
end end
@ -31,10 +31,6 @@ end
end end
unless defined?(NotImplementedError)
NotImplementedError = NotImplementError # :nodoc:
end
module Racc module Racc
class ParseError < StandardError; end class ParseError < StandardError; end
end end

8
lib/rdoc/rd/inline_parser.rb
Просмотреть файл

@ -1,7 +1,7 @@
# frozen_string_literal: true # frozen_string_literal: true
# #
# DO NOT MODIFY!!!! # DO NOT MODIFY!!!!
# This file is automatically generated by Racc 1.7.3 # This file is automatically generated by Racc 1.8.0
# from Racc grammar file "inline_parser.ry". # from Racc grammar file "inline_parser.ry".
# #
@ -23,7 +23,7 @@ unless $".find {|p| p.end_with?('/racc/info.rb')}
$".push "#{__dir__}/racc/info.rb" $".push "#{__dir__}/racc/info.rb"
module Racc module Racc
VERSION = '1.7.3' VERSION = '1.8.0'
Version = VERSION Version = VERSION
Copyright = 'Copyright (c) 1999-2006 Minero Aoki' Copyright = 'Copyright (c) 1999-2006 Minero Aoki'
end end
@ -31,10 +31,6 @@ end
end end
unless defined?(NotImplementedError)
NotImplementedError = NotImplementError # :nodoc:
end
module Racc module Racc
class ParseError < StandardError; end class ParseError < StandardError; end
end end

3
lib/rdoc/rdoc.gemspec
Просмотреть файл

@ -230,9 +230,8 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
s.rdoc_options = ["--main", "README.rdoc"] s.rdoc_options = ["--main", "README.rdoc"]
s.extra_rdoc_files += s.files.grep(%r[\A[^\/]+\.(?:rdoc|md)\z]) s.extra_rdoc_files += s.files.grep(%r[\A[^\/]+\.(?:rdoc|md)\z])
s.required_ruby_version = Gem::Requirement.new(">= 2.7.0") s.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
s.required_rubygems_version = Gem::Requirement.new(">= 2.2") s.required_rubygems_version = Gem::Requirement.new(">= 2.2")
s.add_dependency 'prism', '>= 0.30.0'
s.add_dependency 'psych', '>= 4.0.0' s.add_dependency 'psych', '>= 4.0.0'
end end

2
test/rdoc/test_rdoc_rdoc.rb
Просмотреть файл

@ -194,7 +194,7 @@ class TestRDocRDoc < RDoc::TestCase
File.write('.document', "a.rb\n""b.rb\n") File.write('.document', "a.rb\n""b.rb\n")
expected_files << a expected_files << a
@rdoc.options.exclude = Regexp.new(['b.rb'].join('|')) @rdoc.options.exclude = /b\.rb$/
@rdoc.normalized_file_list [File.realpath(dir)] @rdoc.normalized_file_list [File.realpath(dir)]
end end