From 20445fd37e5cc4980bcced7b9c388f3e31a44bc2 Mon Sep 17 00:00:00 2001 From: Aditya Ardiya Date: Sun, 16 Jan 2022 02:12:01 +0900 Subject: [PATCH 0001/1353] Improve point_cloud_library clean_html --- lib/docs/filters/point_cloud_library/clean_html.rb | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/lib/docs/filters/point_cloud_library/clean_html.rb b/lib/docs/filters/point_cloud_library/clean_html.rb index 143345d682..29f1faa031 100644 --- a/lib/docs/filters/point_cloud_library/clean_html.rb +++ b/lib/docs/filters/point_cloud_library/clean_html.rb @@ -5,6 +5,18 @@ def call @doc = at_css('.contents') css('.dynheader.closed').remove css('.permalink').remove + css('.memSeparator').remove + + # Change div.fragment to C++ code with syntax highlight + css('div.fragment').each do |node| + node.name = 'pre' + node['data-language'] = 'cpp' + node_content = "" + node.css('div').each do |inner_node| + node_content += inner_node.text + "\n" + end + node.content = node_content + end doc end end From 2da05d74db2b65417893746de55496d2fc86f572 Mon Sep 17 00:00:00 2001 From: Paul Sernatinger Date: Mon, 14 Nov 2022 08:30:30 -0600 Subject: [PATCH 0002/1353] Specs all passing --- .ruby-version | 2 +- Gemfile | 47 +++--- Gemfile.lock | 145 +++++++++--------- docs/maintainers.md | 1 + lib/app.rb | 17 +- lib/docs/core/request.rb | 2 +- lib/docs/core/requester.rb | 16 +- lib/docs/core/scraper.rb | 2 +- lib/tasks/updates.thor | 2 +- test/lib/docs/core/doc_test.rb | 10 +- test/lib/docs/core/entry_index_test.rb | 4 +- test/lib/docs/core/filter_test.rb | 6 +- test/lib/docs/core/instrumentable_test.rb | 4 +- test/lib/docs/core/manifest_test.rb | 4 +- test/lib/docs/core/models/entry_test.rb | 4 +- test/lib/docs/core/models/type_test.rb | 4 +- test/lib/docs/core/parser_test.rb | 4 +- test/lib/docs/core/request_test.rb | 8 +- test/lib/docs/core/requester_test.rb | 8 +- test/lib/docs/core/response_test.rb | 4 +- test/lib/docs/core/scraper_test.rb | 6 +- .../docs/core/scrapers/file_scraper_test.rb | 4 +- .../docs/core/scrapers/url_scraper_test.rb | 14 +- test/lib/docs/core/url_test.rb | 4 +- .../docs/filters/core/apply_base_url_test.rb | 4 +- test/lib/docs/filters/core/clean_html_test.rb | 4 +- test/lib/docs/filters/core/clean_text_test.rb | 4 +- test/lib/docs/filters/core/container_test.rb | 4 +- test/lib/docs/filters/core/entries_test.rb | 4 +- test/lib/docs/filters/core/inner_html_test.rb | 4 +- .../docs/filters/core/internal_urls_test.rb | 4 +- .../docs/filters/core/normalize_paths_test.rb | 4 +- .../docs/filters/core/normalize_urls_test.rb | 4 +- .../docs/filters/core/parse_cf_email_test.rb | 4 +- test/lib/docs/filters/core/title_test.rb | 4 +- test/lib/docs/storage/abstract_store_test.rb | 6 +- test/lib/docs/storage/file_store_test.rb | 4 +- 37 files changed, 198 insertions(+), 178 deletions(-) diff --git a/.ruby-version b/.ruby-version index 49cdd668e1..ef538c2810 100644 --- a/.ruby-version +++ b/.ruby-version @@ -1 +1 @@ -2.7.6 +3.1.2 diff --git a/Gemfile b/Gemfile index ee87a78408..bd5c4fb470 100644 --- a/Gemfile +++ b/Gemfile @@ -1,37 +1,38 @@ source 'https://rubygems.org' -ruby '~> 2.7.3' +ruby '3.1.2' -gem 'rake' -gem 'thor' -gem 'pry', '~> 0.14.0' -gem 'activesupport', '~> 5.2', require: false -gem 'yajl-ruby', require: false +gem 'activesupport', require: false gem 'html-pipeline' -gem 'typhoeus' gem 'nokogiri' +gem 'pry-byebug' +gem 'rake' gem 'terminal-table' +gem 'thor' +gem 'typhoeus' +gem 'yajl-ruby', require: false group :app do + gem 'browser' + gem 'chunky_png' + gem 'coffee-script' + gem 'erubi' + gem 'image_optim_pack', platforms: :ruby + gem 'image_optim' + gem 'rack-ssl-enforcer' gem 'rack' - gem 'sinatra' + gem 'rss' + gem 'sass' gem 'sinatra-contrib' - gem 'rack-ssl-enforcer' - gem 'thin' - gem 'sprockets' + gem 'sinatra' gem 'sprockets-helpers' - gem 'erubi' - gem 'browser' - gem 'sass' - gem 'coffee-script' - gem 'chunky_png' gem 'sprockets-sass' - gem 'image_optim' - gem 'image_optim_pack', platforms: :ruby + gem 'sprockets' + gem 'thin' end group :production do - gem 'uglifier' gem 'newrelic_rpm' + gem 'uglifier' end group :development do @@ -39,17 +40,17 @@ group :development do end group :docs do - gem 'redcarpet' + gem 'net-sftp', require: false gem 'progress_bar', require: false - gem 'unix_utils', require: false + gem 'redcarpet' gem 'tty-pager', require: false - gem 'net-sftp', '>= 2.1.3.rc2', require: false + gem 'unix_utils', require: false end group :test do gem 'minitest' - gem 'rr', require: false gem 'rack-test', require: false + gem 'rr', require: false end if ENV['SELENIUM'] == '1' diff --git a/Gemfile.lock b/Gemfile.lock index 63d8dc4a6b..25f03ef290 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,136 +1,138 @@ GEM remote: https://rubygems.org/ specs: - activesupport (5.2.6) + activesupport (7.0.4) concurrent-ruby (~> 1.0, >= 1.0.2) - i18n (>= 0.7, < 2) - minitest (~> 5.1) - tzinfo (~> 1.1) - backports (3.15.0) + i18n (>= 1.6, < 2) + minitest (>= 5.1) + tzinfo (~> 2.0) better_errors (2.9.1) coderay (>= 1.0.0) erubi (>= 1.0.0) rack (>= 0.9.0) - browser (2.6.1) - chunky_png (1.3.11) + browser (5.3.1) + byebug (11.1.3) + chunky_png (1.4.0) coderay (1.1.3) coffee-script (2.4.1) coffee-script-source execjs coffee-script-source (1.12.2) - concurrent-ruby (1.1.9) - daemons (1.4.0) - erubi (1.10.0) - ethon (0.12.0) - ffi (>= 1.3.0) + concurrent-ruby (1.1.10) + daemons (1.4.1) + erubi (1.11.0) + ethon (0.16.0) + ffi (>= 1.15.0) eventmachine (1.2.7) - execjs (2.7.0) - exifr (1.3.6) + execjs (2.8.1) + exifr (1.3.10) ffi (1.15.5) fspath (3.1.2) highline (2.0.3) - html-pipeline (2.12.0) + html-pipeline (2.14.3) activesupport (>= 2) nokogiri (>= 1.4) - i18n (1.8.10) + i18n (1.12.0) concurrent-ruby (~> 1.0) - image_optim (0.26.5) + image_optim (0.31.1) exifr (~> 1.2, >= 1.2.2) fspath (~> 3.0) - image_size (>= 1.5, < 3) + image_size (>= 1.5, < 4) in_threads (~> 1.3) progress (~> 3.0, >= 3.0.1) - image_optim_pack (0.6.0) + image_optim_pack (0.9.1.20221104) fspath (>= 2.1, < 4) image_optim (~> 0.19) - image_size (2.0.2) - in_threads (1.5.3) + image_size (3.2.0) + in_threads (1.6.0) method_source (1.0.0) mini_portile2 (2.8.0) - minitest (5.14.4) - multi_json (1.13.1) - mustermann (1.1.1) + minitest (5.16.3) + multi_json (1.15.0) + mustermann (3.0.0) ruby2_keywords (~> 0.0.1) - net-sftp (3.0.0.beta1) - net-ssh (>= 5.0.0, < 6.0.0) - net-ssh (5.2.0) - newrelic_rpm (6.7.0.359) + net-sftp (4.0.0) + net-ssh (>= 5.0.0, < 8.0.0) + net-ssh (7.0.1) + newrelic_rpm (8.12.0) nokogiri (1.13.9) mini_portile2 (~> 2.8.0) racc (~> 1.4) options (2.3.2) - progress (3.5.2) - progress_bar (1.3.0) + progress (3.6.0) + progress_bar (1.3.3) highline (>= 1.6, < 3) options (~> 2.3.0) pry (0.14.1) coderay (~> 1.1) method_source (~> 1.0) + pry-byebug (3.10.1) + byebug (~> 11.0) + pry (>= 0.13, < 0.15) racc (1.6.0) - rack (2.2.3.1) - rack-protection (2.0.7) + rack (2.2.4) + rack-protection (3.0.3) rack rack-ssl-enforcer (0.2.9) - rack-test (1.1.0) - rack (>= 1.0, < 3) - rake (13.0.0) - rb-fsevent (0.10.3) - rb-inotify (0.10.0) + rack-test (2.0.2) + rack (>= 1.3) + rake (13.0.6) + rb-fsevent (0.11.2) + rb-inotify (0.10.1) ffi (~> 1.0) redcarpet (3.5.1) - rr (1.2.1) + rexml (3.2.5) + rr (3.1.0) + rss (0.2.9) + rexml ruby2_keywords (0.0.5) sass (3.7.4) sass-listen (~> 4.0.0) sass-listen (4.0.0) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) - sinatra (2.0.7) - mustermann (~> 1.0) - rack (~> 2.0) - rack-protection (= 2.0.7) + sinatra (3.0.3) + mustermann (~> 3.0) + rack (~> 2.2, >= 2.2.4) + rack-protection (= 3.0.3) tilt (~> 2.0) - sinatra-contrib (2.0.7) - backports (>= 2.8.2) + sinatra-contrib (3.0.3) multi_json - mustermann (~> 1.0) - rack-protection (= 2.0.7) - sinatra (= 2.0.7) + mustermann (~> 3.0) + rack-protection (= 3.0.3) + sinatra (= 3.0.3) tilt (~> 2.0) sprockets (3.7.2) concurrent-ruby (~> 1.0) rack (> 1, < 3) - sprockets-helpers (1.2.1) + sprockets-helpers (1.4.0) sprockets (>= 2.2) sprockets-sass (2.0.0.beta2) sprockets (>= 2.0, < 4.0) - strings (0.1.6) - strings-ansi (~> 0.1) - unicode-display_width (~> 1.5) + strings (0.2.1) + strings-ansi (~> 0.2) + unicode-display_width (>= 1.5, < 3.0) unicode_utils (~> 1.4) - strings-ansi (0.1.0) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) + strings-ansi (0.2.0) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) thin (1.8.1) daemons (~> 1.0, >= 1.0.9) eventmachine (~> 1.0, >= 1.0.4) rack (>= 1, < 3) - thor (0.20.3) - thread_safe (0.3.6) - tilt (2.0.10) - tty-pager (0.12.1) - strings (~> 0.1.4) - tty-screen (~> 0.6) - tty-which (~> 0.4) - tty-screen (0.7.0) - tty-which (0.4.1) - typhoeus (1.3.1) + thor (1.2.1) + tilt (2.0.11) + tty-pager (0.14.0) + strings (~> 0.2.0) + tty-screen (~> 0.8) + tty-screen (0.8.1) + typhoeus (1.4.0) ethon (>= 0.9.0) - tzinfo (1.2.10) - thread_safe (~> 0.1) + tzinfo (2.0.5) + concurrent-ruby (~> 1.0) uglifier (4.2.0) execjs (>= 0.3.0, < 3) - unicode-display_width (1.6.0) + unicode-display_width (2.3.0) unicode_utils (1.4.0) unix_utils (0.0.15) yajl-ruby (1.4.3) @@ -139,7 +141,7 @@ PLATFORMS ruby DEPENDENCIES - activesupport (~> 5.2) + activesupport better_errors browser chunky_png @@ -149,17 +151,18 @@ DEPENDENCIES image_optim image_optim_pack minitest - net-sftp (>= 2.1.3.rc2) + net-sftp newrelic_rpm nokogiri progress_bar - pry (~> 0.14.0) + pry-byebug rack rack-ssl-enforcer rack-test rake redcarpet rr + rss sass sinatra sinatra-contrib @@ -176,7 +179,7 @@ DEPENDENCIES yajl-ruby RUBY VERSION - ruby 2.7.3p183 + ruby 3.1.2p20 BUNDLED WITH 2.1.4 diff --git a/docs/maintainers.md b/docs/maintainers.md index e8483a41c7..24436b73fb 100644 --- a/docs/maintainers.md +++ b/docs/maintainers.md @@ -125,6 +125,7 @@ The following people (used to) maintain DevDocs: - [Jed Fox](https://github.com/j-f1) - [Mrugesh Mohapatra](https://github.com/raisedadead) - [Oliver Eyton-Williams](https://github.com/ojeytonwilliams) +- [Paul Sernatinger](https://github.com/oscillot) - [Simon Legner](https://github.com/simon04) - [Thibaut Courouble](https://github.com/thibaut) diff --git a/lib/app.rb b/lib/app.rb index 43ce2a4ebe..6d197b4ae2 100644 --- a/lib/app.rb +++ b/lib/app.rb @@ -238,7 +238,22 @@ def redirect_via_js(path) end def supports_js_redirection? - browser.modern? && !memoized_cookies.empty? + modern_browser?(browser) && !memoized_cookies.empty? + end + + # https://github.com/fnando/browser#detecting-modern-browsers + # https://github.com/fnando/browser/blob/v2.6.1/lib/browser/browser.rb + # This restores the old browser gem `#modern?` functionality as it was in 2.6.1 + # It's possible this isn't even really needed any longer, these versions are quite old now + def modern_browser?(browser) + [ + browser.webkit?, + browser.firefox? && browser.version.to_i >= 17, + browser.ie? && browser.version.to_i >= 9 && !browser.compatibility_view?, + browser.edge? && !browser.compatibility_view?, + browser.opera? && browser.version.to_i >= 12, + browser.firefox? && browser.device.tablet? && browser.platform.android? && b.version.to_i >= 14 + ].any? end end diff --git a/lib/docs/core/request.rb b/lib/docs/core/request.rb index b1e26e68d6..2a7f96c6d5 100644 --- a/lib/docs/core/request.rb +++ b/lib/docs/core/request.rb @@ -13,7 +13,7 @@ def self.run(*args, &block) request.run end - def initialize(url, options = {}) + def initialize(url, **options) super url.to_s, DEFAULT_OPTIONS.merge(options) end diff --git a/lib/docs/core/requester.rb b/lib/docs/core/requester.rb index 6c7f5b6a80..ed8bafcb5d 100644 --- a/lib/docs/core/requester.rb +++ b/lib/docs/core/requester.rb @@ -4,10 +4,10 @@ class Requester < Typhoeus::Hydra attr_reader :request_options - def self.run(urls, options = {}, &block) + def self.run(urls, **options, &block) urls = urls.dup - requester = new(options) - requester.on_response(&block) if block + requester = new(**options) + requester.on_response(&block) if block_given? requester.on_response do # cheap hack to ensure root page is processed first if urls requester.request(urls) @@ -19,16 +19,16 @@ def self.run(urls, options = {}, &block) requester end - def initialize(options = {}) + def initialize(**options) @request_options = options.extract!(:request_options)[:request_options].try(:dup) || {} options[:max_concurrency] ||= 20 options[:pipelining] = 0 super end - def request(urls, options = {}, &block) + def request(urls, **options, &block) requests = [urls].flatten.map do |url| - build_and_queue_request(url, options, &block) + build_and_queue_request(url, **options, &block) end requests.length == 1 ? requests.first : requests end @@ -46,8 +46,8 @@ def on_response(&block) private - def build_and_queue_request(url, options, &block) - request = Request.new(url, request_options.merge(options)) + def build_and_queue_request(url, **options, &block) + request = Request.new(url, **request_options.merge(options)) request.on_complete(&block) if block queue(request) request diff --git a/lib/docs/core/scraper.rb b/lib/docs/core/scraper.rb index 083b0015eb..007580ed50 100644 --- a/lib/docs/core/scraper.rb +++ b/lib/docs/core/scraper.rb @@ -51,7 +51,7 @@ def initialize end def initialize_stubs - self.class.stubs.each do |path, block| + self.class.stubs.each do |path, &block| Typhoeus.stub(url_for(path)).and_return do Typhoeus::Response.new \ effective_url: url_for(path), diff --git a/lib/tasks/updates.thor b/lib/tasks/updates.thor index 62dcf20c11..5dd1539749 100644 --- a/lib/tasks/updates.thor +++ b/lib/tasks/updates.thor @@ -259,7 +259,7 @@ Maintainers can close this issue when all documentations are up-to-date. The iss # HTTP utilities # - def github_get(endpoint, params = {}) + def github_get(endpoint, **params) github_request(endpoint, {method: :get, params: params}) end diff --git a/test/lib/docs/core/doc_test.rb b/test/lib/docs/core/doc_test.rb index 3da1fcfc41..b0d2341f84 100644 --- a/test/lib/docs/core/doc_test.rb +++ b/test/lib/docs/core/doc_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsDocTest < MiniTest::Spec let :doc do @@ -197,7 +197,7 @@ class DocsDocTest < MiniTest::Spec it "opens the .path directory before storing the file" do stub(doc).path { 'path' } stub(store).write { assert false } - mock(store).open('path') do |_, block| + mock(store).open('path') do |_, &block| stub(store).write block.call end @@ -258,7 +258,7 @@ class DocsDocTest < MiniTest::Spec before do any_instance_of(doc) do |instance| - stub(instance).build_pages { |block| pages.each(&block) } + stub(instance).build_pages { |&block| pages.each(&block) } end end @@ -313,7 +313,7 @@ class DocsDocTest < MiniTest::Spec it "replaces the .path directory before storing the files" do stub(doc).path { 'path' } stub(store).write { assert false } - mock(store).replace('path') do |_, block| + mock(store).replace('path') do |_, &block| stub(store).write block.call end diff --git a/test/lib/docs/core/entry_index_test.rb b/test/lib/docs/core/entry_index_test.rb index 0f8b0b187d..187f5f4ad2 100644 --- a/test/lib/docs/core/entry_index_test.rb +++ b/test/lib/docs/core/entry_index_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsEntryIndexTest < MiniTest::Spec let :entry do diff --git a/test/lib/docs/core/filter_test.rb b/test/lib/docs/core/filter_test.rb index 77265c222a..38c5019a3f 100644 --- a/test/lib/docs/core/filter_test.rb +++ b/test/lib/docs/core/filter_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsFilterTest < MiniTest::Spec include FilterTestHelper @@ -19,7 +19,7 @@ class DocsFilterTest < MiniTest::Spec describe "#subpath_to" do it "returns the subpath from the #base_url to the url, ignoring case" do - stub(filter.base_url).subpath_to('url', hash_including(ignore_case: true)) { 'subpath' } + stub(filter.base_url).subpath_to('url', ignore_case: true) { 'subpath' } assert_equal 'subpath', filter.subpath_to('url') end end diff --git a/test/lib/docs/core/instrumentable_test.rb b/test/lib/docs/core/instrumentable_test.rb index 0c8fc95638..c3fe2b8b6b 100644 --- a/test/lib/docs/core/instrumentable_test.rb +++ b/test/lib/docs/core/instrumentable_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsInstrumentableTest < MiniTest::Spec let :extended_class do diff --git a/test/lib/docs/core/manifest_test.rb b/test/lib/docs/core/manifest_test.rb index 16484a7016..583b2ceeac 100644 --- a/test/lib/docs/core/manifest_test.rb +++ b/test/lib/docs/core/manifest_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class ManifestTest < MiniTest::Spec let :doc do diff --git a/test/lib/docs/core/models/entry_test.rb b/test/lib/docs/core/models/entry_test.rb index 307cdaac43..7487340ff2 100644 --- a/test/lib/docs/core/models/entry_test.rb +++ b/test/lib/docs/core/models/entry_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class DocsEntryTest < MiniTest::Spec Entry = Docs::Entry diff --git a/test/lib/docs/core/models/type_test.rb b/test/lib/docs/core/models/type_test.rb index 8d95ea36cc..a01d8e6140 100644 --- a/test/lib/docs/core/models/type_test.rb +++ b/test/lib/docs/core/models/type_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class DocsTypeTest < MiniTest::Spec Type = Docs::Type diff --git a/test/lib/docs/core/parser_test.rb b/test/lib/docs/core/parser_test.rb index 21f62c39d6..440516a8e9 100644 --- a/test/lib/docs/core/parser_test.rb +++ b/test/lib/docs/core/parser_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsParserTest < MiniTest::Spec def parser(content) diff --git a/test/lib/docs/core/request_test.rb b/test/lib/docs/core/request_test.rb index a5a9e48c04..d05dd1ffe9 100644 --- a/test/lib/docs/core/request_test.rb +++ b/test/lib/docs/core/request_test.rb @@ -1,13 +1,13 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsRequestTest < MiniTest::Spec let :url do 'http://example.com' end - def request(url = self.url, options = {}) - Docs::Request.new(url, options).tap do |request| + def request(url = self.url, **options) + Docs::Request.new(url, **options).tap do |request| request.extend FakeInstrumentation end end diff --git a/test/lib/docs/core/requester_test.rb b/test/lib/docs/core/requester_test.rb index 63eace1aa4..acf8d0a9a2 100644 --- a/test/lib/docs/core/requester_test.rb +++ b/test/lib/docs/core/requester_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsRequesterTest < MiniTest::Spec def stub_request(url) @@ -7,7 +7,7 @@ def stub_request(url) end let :requester do - Docs::Requester.new(options) + Docs::Requester.new(**options) end let :url do @@ -81,7 +81,7 @@ def stub_request(url) end it "returns an array of requests" do - result = requester.request(urls, { params: 'test' }, &block) + result = requester.request(urls, params: 'test', &block) assert_instance_of Array, result assert_equal urls.length, result.length assert result.all? { |obj| obj.instance_of? Docs::Request } diff --git a/test/lib/docs/core/response_test.rb b/test/lib/docs/core/response_test.rb index 4142752d02..9e92c034fc 100644 --- a/test/lib/docs/core/response_test.rb +++ b/test/lib/docs/core/response_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsResponseTest < MiniTest::Spec let :response do diff --git a/test/lib/docs/core/scraper_test.rb b/test/lib/docs/core/scraper_test.rb index 25e0af3b0e..3d49320743 100644 --- a/test/lib/docs/core/scraper_test.rb +++ b/test/lib/docs/core/scraper_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsScraperTest < MiniTest::Spec class Scraper < Docs::Scraper @@ -223,7 +223,7 @@ class Scraper < Docs::Scraper context "when the response is processable" do before do - stub(scraper).request_all do |urls, block| + stub(scraper).request_all do |urls, &block| urls.each { |url| @next_urls ||= block.call(response) } end stub(scraper).handle_response(response) { processed_response } diff --git a/test/lib/docs/core/scrapers/file_scraper_test.rb b/test/lib/docs/core/scrapers/file_scraper_test.rb index 88b5e8d5ec..46dad3c780 100644 --- a/test/lib/docs/core/scrapers/file_scraper_test.rb +++ b/test/lib/docs/core/scrapers/file_scraper_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class FileScraperTest < MiniTest::Spec ROOT_PATH = File.expand_path('../../../../../../', __FILE__) diff --git a/test/lib/docs/core/scrapers/url_scraper_test.rb b/test/lib/docs/core/scrapers/url_scraper_test.rb index 5ff72231ea..9a687256ab 100644 --- a/test/lib/docs/core/scrapers/url_scraper_test.rb +++ b/test/lib/docs/core/scrapers/url_scraper_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class DocsUrlScraperTest < MiniTest::Spec class Scraper < Docs::UrlScraper @@ -54,29 +54,29 @@ class Scraper < Docs::UrlScraper end it "runs a Requester with the given urls" do - mock(Docs::Requester).run 'urls', anything + mock(Docs::Requester).run('urls', request_options: {params: {}, headers: {"User-Agent" => "DevDocs"}}) result end it "runs a Requester with .headers as :request_options" do stub(Scraper).headers { { testheader: true } } - mock(Docs::Requester).run anything, satisfy { |options| options[:request_options][:headers][:testheader] } + mock(Docs::Requester).run('urls', request_options: {params: {}, headers: {testheader: true}}) result end it "runs a Requester with default .headers as :request_options" do - mock(Docs::Requester).run anything, satisfy { |options| options[:request_options][:headers]["User-Agent"] } + mock(Docs::Requester).run('urls', request_options: {params: {}, headers: {"User-Agent" => "DevDocs"}}) result end it "runs a Requester with .params as :request_options" do stub(Scraper).params { { test: true } } - mock(Docs::Requester).run anything, satisfy { |options| options[:request_options][:params][:test] } + mock(Docs::Requester).run('urls', request_options: {params: {test: true}, headers: {"User-Agent" => "DevDocs"}}) result end it "runs a Requester with the given block" do - stub(Docs::Requester).run { |*args| @block = args.last } + stub(Docs::Requester).run { |*_args, **_kwargs, &block| @block = block } result assert_equal block, @block end diff --git a/test/lib/docs/core/url_test.rb b/test/lib/docs/core/url_test.rb index 08839b54cc..7d4bda43de 100644 --- a/test/lib/docs/core/url_test.rb +++ b/test/lib/docs/core/url_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsUrlTest < MiniTest::Spec URL = Docs::URL diff --git a/test/lib/docs/filters/core/apply_base_url_test.rb b/test/lib/docs/filters/core/apply_base_url_test.rb index e627d95936..ba2764e7a8 100644 --- a/test/lib/docs/filters/core/apply_base_url_test.rb +++ b/test/lib/docs/filters/core/apply_base_url_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class ApplyBaseUrlFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/filters/core/clean_html_test.rb b/test/lib/docs/filters/core/clean_html_test.rb index a3e163e0ca..2d3c9f8add 100644 --- a/test/lib/docs/filters/core/clean_html_test.rb +++ b/test/lib/docs/filters/core/clean_html_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class CleanHtmlFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/filters/core/clean_text_test.rb b/test/lib/docs/filters/core/clean_text_test.rb index ec08b6e6c7..7babf15e48 100644 --- a/test/lib/docs/filters/core/clean_text_test.rb +++ b/test/lib/docs/filters/core/clean_text_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class CleanTextFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/filters/core/container_test.rb b/test/lib/docs/filters/core/container_test.rb index cdf08c0d2d..7d4993e8b4 100644 --- a/test/lib/docs/filters/core/container_test.rb +++ b/test/lib/docs/filters/core/container_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class ContainerFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/filters/core/entries_test.rb b/test/lib/docs/filters/core/entries_test.rb index 0fa843a08d..e33f778d01 100644 --- a/test/lib/docs/filters/core/entries_test.rb +++ b/test/lib/docs/filters/core/entries_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class EntriesFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/filters/core/inner_html_test.rb b/test/lib/docs/filters/core/inner_html_test.rb index 194cc555f1..bbd4095848 100644 --- a/test/lib/docs/filters/core/inner_html_test.rb +++ b/test/lib/docs/filters/core/inner_html_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class InnerHtmlFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/filters/core/internal_urls_test.rb b/test/lib/docs/filters/core/internal_urls_test.rb index 5d9df46985..c9194e09e0 100644 --- a/test/lib/docs/filters/core/internal_urls_test.rb +++ b/test/lib/docs/filters/core/internal_urls_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class InternalUrlsFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/filters/core/normalize_paths_test.rb b/test/lib/docs/filters/core/normalize_paths_test.rb index b3fc120df8..6d407f2b0b 100644 --- a/test/lib/docs/filters/core/normalize_paths_test.rb +++ b/test/lib/docs/filters/core/normalize_paths_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class NormalizePathsFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/filters/core/normalize_urls_test.rb b/test/lib/docs/filters/core/normalize_urls_test.rb index 7e2a56e524..804b05b159 100644 --- a/test/lib/docs/filters/core/normalize_urls_test.rb +++ b/test/lib/docs/filters/core/normalize_urls_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class NormalizeUrlsFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/filters/core/parse_cf_email_test.rb b/test/lib/docs/filters/core/parse_cf_email_test.rb index ed0a922974..d6124fedac 100644 --- a/test/lib/docs/filters/core/parse_cf_email_test.rb +++ b/test/lib/docs/filters/core/parse_cf_email_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class ParseCfEmailFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/filters/core/title_test.rb b/test/lib/docs/filters/core/title_test.rb index 69c83fe3dd..9a28bd3bee 100644 --- a/test/lib/docs/filters/core/title_test.rb +++ b/test/lib/docs/filters/core/title_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../../test_helper' +require_relative '../../../../../lib/docs' class TitleFilterTest < MiniTest::Spec include FilterTestHelper diff --git a/test/lib/docs/storage/abstract_store_test.rb b/test/lib/docs/storage/abstract_store_test.rb index f552cd4a81..d63e95f226 100644 --- a/test/lib/docs/storage/abstract_store_test.rb +++ b/test/lib/docs/storage/abstract_store_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsAbstractStoreTest < MiniTest::Spec InvalidPathError = Docs::AbstractStore::InvalidPathError @@ -368,7 +368,7 @@ class DocsAbstractStoreTest < MiniTest::Spec end def stub_paths(*paths) - stub(store).each { |block| paths.each(&block) } + stub(store).each { |&block| paths.each(&block) } end it "calls the block" do diff --git a/test/lib/docs/storage/file_store_test.rb b/test/lib/docs/storage/file_store_test.rb index 586d8a41b5..aa3ce3f8ec 100644 --- a/test/lib/docs/storage/file_store_test.rb +++ b/test/lib/docs/storage/file_store_test.rb @@ -1,5 +1,5 @@ -require 'test_helper' -require 'docs' +require_relative '../../../test_helper' +require_relative '../../../../lib/docs' class DocsFileStoreTest < MiniTest::Spec let :store do From ed50204d8bd167bfb2f15f8f43b8e4fa9712b008 Mon Sep 17 00:00:00 2001 From: Paul Sernatinger Date: Mon, 14 Nov 2022 08:47:09 -0600 Subject: [PATCH 0003/1353] Update docker base images, copyright year, add self to maintainers --- COPYRIGHT | 2 +- Dockerfile | 3 +-- Dockerfile-alpine | 2 +- docs/maintainers.md | 1 + 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/COPYRIGHT b/COPYRIGHT index 8b56007921..36daa5b03e 100644 --- a/COPYRIGHT +++ b/COPYRIGHT @@ -1,4 +1,4 @@ -Copyright 2013-2021 Thibaut Courouble and other contributors +Copyright 2013-2022 Thibaut Courouble and other contributors This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this diff --git a/Dockerfile b/Dockerfile index 060193dfd5..4079b747bc 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,4 @@ -FROM ruby:2.7.6 - +FROM ruby:3.1.2 ENV LANG=C.UTF-8 ENV ENABLE_SERVICE_WORKER=true diff --git a/Dockerfile-alpine b/Dockerfile-alpine index dcd296a257..6575e2d77a 100644 --- a/Dockerfile-alpine +++ b/Dockerfile-alpine @@ -1,4 +1,4 @@ -FROM ruby:2.7.6-alpine +FROM ruby:3.1.2-alpine ENV LANG=C.UTF-8 ENV ENABLE_SERVICE_WORKER=true diff --git a/docs/maintainers.md b/docs/maintainers.md index 24436b73fb..cd85fc0871 100644 --- a/docs/maintainers.md +++ b/docs/maintainers.md @@ -32,6 +32,7 @@ In order to deploy DevDocs, you must: - be given access to DevDocs's [Sentry instance](https://sentry.io/devdocs/devdocs-js/) (for JS error tracking) and familiarize yourself with its UI. - be provided with DevDocs's S3 credentials, and install (`brew install awscli` on macOS) and [configure](https://docs.aws.amazon.com/cli/latest/reference/configure/) the AWS CLI on your computer. The configuration must add a named profile called "devdocs": + ``` aws configure --profile devdocs ``` From 3d325b846112ea73532e862786e920946fc87fbe Mon Sep 17 00:00:00 2001 From: Paul Sernatinger Date: Mon, 14 Nov 2022 20:57:28 -0600 Subject: [PATCH 0004/1353] Update .tool-version file for asdf users --- .tool-versions | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.tool-versions b/.tool-versions index 1ade73219b..0b2d858781 100644 --- a/.tool-versions +++ b/.tool-versions @@ -1 +1 @@ -ruby 2.7.4 +ruby 3.1.2 From f803d30160f8037557fdbadc8f61b182c4e4ad2d Mon Sep 17 00:00:00 2001 From: Paul Sernatinger Date: Fri, 18 Nov 2022 22:28:43 -0600 Subject: [PATCH 0005/1353] Update Gemfile.lock Co-authored-by: Simon Legner --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 25f03ef290..535836f3c5 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -182,4 +182,4 @@ RUBY VERSION ruby 3.1.2p20 BUNDLED WITH - 2.1.4 + 2.3.11 From c68101a7371d32d4d0bef8929cc997d8e5d4ec00 Mon Sep 17 00:00:00 2001 From: Paul Sernatinger Date: Fri, 18 Nov 2022 22:29:49 -0600 Subject: [PATCH 0006/1353] Address some review comments --- docs/maintainers.md | 1 - lib/docs/filters/core/images.rb | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintainers.md b/docs/maintainers.md index cd85fc0871..fdacd2347e 100644 --- a/docs/maintainers.md +++ b/docs/maintainers.md @@ -126,7 +126,6 @@ The following people (used to) maintain DevDocs: - [Jed Fox](https://github.com/j-f1) - [Mrugesh Mohapatra](https://github.com/raisedadead) - [Oliver Eyton-Williams](https://github.com/ojeytonwilliams) -- [Paul Sernatinger](https://github.com/oscillot) - [Simon Legner](https://github.com/simon04) - [Thibaut Courouble](https://github.com/thibaut) diff --git a/lib/docs/filters/core/images.rb b/lib/docs/filters/core/images.rb index 407583dc37..f63016e332 100644 --- a/lib/docs/filters/core/images.rb +++ b/lib/docs/filters/core/images.rb @@ -1,5 +1,6 @@ # frozen_string_literal: true +require 'base64' require 'image_optim' module Docs From d344c117a6be05bc759c004c6923aeb3ac53c5e9 Mon Sep 17 00:00:00 2001 From: ClasherKasten Date: Sun, 27 Nov 2022 09:02:18 +0100 Subject: [PATCH 0007/1353] Update Dart (2.18.5) --- assets/javascripts/templates/pages/about_tmpl.coffee | 4 ++-- docs/file-scrapers.md | 2 +- lib/docs/scrapers/dart.rb | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 7ca888959e..30c4c479f4 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -238,8 +238,8 @@ credits = [ ], [ 'Dart', '2012 the Dart project authors', - 'CC BY-SA', - 'https://creativecommons.org/licenses/by-sa/4.0/' + 'BSD 3-Clause "New" or "Revised" License', + 'https://raw.githubusercontent.com/dart-lang/sdk/main/LICENSE' ], [ 'date-fns', '2021 Sasha Koss and Lesha Koss', diff --git a/docs/file-scrapers.md b/docs/file-scrapers.md index 648ba38a81..780de56b21 100644 --- a/docs/file-scrapers.md +++ b/docs/file-scrapers.md @@ -23,7 +23,7 @@ and put it in `/path/to/devdocs/docs/` Or run the following commands in your terminal: ```sh -curl https://storage.googleapis.com/dart-archive/channels/stable/release/$RELEASE/api-docs/dartdocs-gen-api-zip > dartApi.zip; \ +curl https://storage.googleapis.com/dart-archive/channels/stable/release/$RELEASE/api-docs/dartdocs-gen-api.zip > dartApi.zip; \ unzip dartApi.zip; mv gen-dartdocs docs/dart~$VERSION ``` diff --git a/lib/docs/scrapers/dart.rb b/lib/docs/scrapers/dart.rb index c12d051ab8..fd04555f81 100644 --- a/lib/docs/scrapers/dart.rb +++ b/lib/docs/scrapers/dart.rb @@ -17,11 +17,11 @@ class Dart < FileScraper options[:attribution] = <<-HTML © 2012 the Dart project authors
- Licensed under the Creative Commons Attribution-ShareAlike License v4.0. + Licensed under the BSD 3-Clause "New" or "Revised" License. HTML version '2' do - self.release = '2.17.0' + self.release = '2.18.5' self.base_url = "https://api.dart.dev/stable/#{release}/" end From a4c7f092ba8c90fd3b8957a6cca7cd90a7ccef14 Mon Sep 17 00:00:00 2001 From: ClasherKasten Date: Sun, 27 Nov 2022 11:46:51 +0100 Subject: [PATCH 0008/1353] Update Erlang (25.1.2) --- docs/file-scrapers.md | 2 +- lib/docs/scrapers/erlang.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/file-scrapers.md b/docs/file-scrapers.md index 648ba38a81..7e3ff57cc6 100644 --- a/docs/file-scrapers.md +++ b/docs/file-scrapers.md @@ -65,7 +65,7 @@ Go to https://www.erlang.org/downloads and download the HTML documentation file. ```ah mkdir --parent docs/erlang\~$VERSION/; \ -curl http://erlang.org/download/otp_doc_html_$RELEASE.tar.gz | \ +curl -L https://github.com/erlang/otp/releases/download/OTP-$RELEASE/otp_doc_html_$RELEASE.tar.gz | \ bsdtar --extract --file - --directory=docs/erlang\~$VERSION/ ``` diff --git a/lib/docs/scrapers/erlang.rb b/lib/docs/scrapers/erlang.rb index ee188d5aac..0330111a4b 100644 --- a/lib/docs/scrapers/erlang.rb +++ b/lib/docs/scrapers/erlang.rb @@ -41,7 +41,7 @@ class Erlang < FileScraper HTML version '25' do - self.release = '25.0' + self.release = '25.1' end version '24' do From 0ca094e65dd7a850d221830698d81002a32697fe Mon Sep 17 00:00:00 2001 From: Vallabh Date: Mon, 28 Nov 2022 22:12:46 +0530 Subject: [PATCH 0009/1353] Added scraper that uses UrlScraper for wagtail --- lib/docs/scrapers/wagtail.rb | 103 +++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 lib/docs/scrapers/wagtail.rb diff --git a/lib/docs/scrapers/wagtail.rb b/lib/docs/scrapers/wagtail.rb new file mode 100644 index 0000000000..891639d499 --- /dev/null +++ b/lib/docs/scrapers/wagtail.rb @@ -0,0 +1,103 @@ +module Docs + class Wagtail < UrlScraper + self.name = 'Wagtail' + self.type = 'sphinx' + self.root_path = 'index.html' + self.links = { + home: 'https://wagtail.org/', + code: 'https://github.com/wagtail/wagtail' + } + + # adding filters from lib/docs/filters/wagtail + html_filters.push 'wagtail/entries', 'sphinx/clean_html', 'wagtail/clean_html' + + # attributions are seen at the bottom of every page(copyright and license etc. details) + options[:attribution] = <<-HTML + © 2014-present Torchbox Ltd and individual contributors.
+ All rights are reserved.
+ Licensed under the BSD License. + HTML + + # no one wants to see docs about search or release notes + options[:skip] = %w[search.html] + options[:skip_patterns] = [ + %r{\Areleases/} + ] + + # updating release and base_url for different versions + version 'stable' do + self.release = 'stable' + self.base_url = 'https://docs.wagtail.org/en/stable/' + end + + version 'latest' do + self.release = 'latest' + self.base_url = 'https://docs.wagtail.org/en/latest/' + end + + version '4.0.4' do + self.release = '4.0.4' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '4.0' do + self.release = '4.0' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '3.0.3' do + self.release = '3.0.3' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '2.16.3' do + self.release = '2.16.3' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '2.15.6' do + self.release = '2.15.6' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '2.10.2' do + self.release = '2.10.2' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '2.5.2' do + self.release = '2.5.2' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '2.4' do + self.release = '2.4' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '2.3' do + self.release = '2.3' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '2.0.2' do + self.release = '2.0.2' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '1.2' do + self.release = '1.2' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + version '1.1' do + self.release = '1.1' + self.base_url = "https://docs.wagtail.org/en/v#{version}/" + end + + # this method will fetch the latest version of wagtail + def get_latest_version(opts) + get_latest_github_release('wagtail', 'wagtail', opts) + end + end +end From d2f26788b739a09faf18a7a2222f456e073d9394 Mon Sep 17 00:00:00 2001 From: Vallabh Date: Mon, 28 Nov 2022 22:13:36 +0530 Subject: [PATCH 0010/1353] Created html and entries filters for wagtail --- lib/docs/filters/wagtail/clean_html.rb | 65 ++++++++++++++++++++++++++ lib/docs/filters/wagtail/entries.rb | 15 ++++++ 2 files changed, 80 insertions(+) create mode 100644 lib/docs/filters/wagtail/clean_html.rb create mode 100644 lib/docs/filters/wagtail/entries.rb diff --git a/lib/docs/filters/wagtail/clean_html.rb b/lib/docs/filters/wagtail/clean_html.rb new file mode 100644 index 0000000000..b5b28b5368 --- /dev/null +++ b/lib/docs/filters/wagtail/clean_html.rb @@ -0,0 +1,65 @@ +module Docs + class Wagtail + class CleanHtmlFilter < Filter + def call + # footer contains links like about,contact us etc which + # are not needed in documentation so removed + doc.search('footer').each do |footer| + footer.remove + end + + # aside bar contains the search bar and navigation links + # which are not needed + doc.search('aside').each do |aside| + aside.remove + end + + # header contains links which are not needed(see sourch code of Wagtail docs) + doc.search('header').each do |head| + head.remove + end + + # nav bar contains the search bar and navigation links(older versions) + # which are not needed + doc.search('nav.wy-nav-side').each do |nav| + nav.remove + end + + # removing unimportant links(older versions) + doc.search('nav.wy-nav-top').each do |nav| + nav.remove + end + + # removing unimportant links from header of very old versions + doc.search('ul.wy-breadcrumbs').each do |ul| + ul.remove + end + + # removing release notes + doc.search('li.toctree-l1').each do |li| + li.remove if li.to_s.include? 'Release notes' + end + + # removing release notes(older versions) + doc.search('dl').each do |dl| + dl.remove + end + + # removing scripts and style + css('script', 'style', 'link').remove + css('hr').remove + # Make proper table headers + css('td.header').each do |node| + node.name = 'th' + end + + # Remove code highlighting + css('pre').each do |node| + node.content = node.content + end + + doc + end + end + end +end diff --git a/lib/docs/filters/wagtail/entries.rb b/lib/docs/filters/wagtail/entries.rb new file mode 100644 index 0000000000..8af4c4c7a9 --- /dev/null +++ b/lib/docs/filters/wagtail/entries.rb @@ -0,0 +1,15 @@ +module Docs + class Wagtail + class EntriesFilter < Docs::EntriesFilter + def get_name + # removing the pilcrow sign and returning the heading + at_css('h1').content.strip.remove("\u{00b6}") + end + + def get_type + object, method = *slug.split('/') + method ? object : 'Miscellaneous' + end + end + end +end From 434cdde336e176b6143eb2f53967820b632604aa Mon Sep 17 00:00:00 2001 From: Vallabh Date: Mon, 28 Nov 2022 22:14:41 +0530 Subject: [PATCH 0011/1353] Added icons(16x16 and 32x32) for wagtail docs --- public/icons/docs/wagtail/16.png | Bin 0 -> 553 bytes public/icons/docs/wagtail/16@2x.png | Bin 0 -> 1234 bytes 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 public/icons/docs/wagtail/16.png create mode 100644 public/icons/docs/wagtail/16@2x.png diff --git a/public/icons/docs/wagtail/16.png b/public/icons/docs/wagtail/16.png new file mode 100644 index 0000000000000000000000000000000000000000..73a98e39316c2d973dac46ded85078ab22de63a7 GIT binary patch literal 553 zcmV+^0@nSBP)00001b5ch_0Itp) z=>Px$<4Ht8R5(vflEF)qQ5400rx_h*GSeo=anT}Z7uiBlh-T#&RIAoPe}VHanC>cQ z5#&CkWfZ8}C^R>NK@veU3yGPgR+AHCSi_C`zW1z;$H)8L_wKppoO?uggk%tw2pc~O zJ3EUg$!Ht&{Y+u`CExkoSb`W7td5=@y;GZ?&(~^mTg%HU*ITXjVStm#5o37vq3akaLP% zf=}74HDDnXIE|_4DRvu;Ltw2bq|tU}khWohEQG(m%#@cIyT= zou}KM8^|$vd6M0?yG~>UwB%69J9ndsc!fD-Q8_ox@Tp;%%}=iLHE;v?=?o+V8YeI| zC7UY@74xNHk=~CU{onmBCVMR7p^0B<_{nmwoDo_z>>22*V9&%mnH{C5C97OV=9+jR z({mF~vJfV`V^_0*rng`k>7|*S2fF|4jPx(j7da6R7gvWmQQG0RTRd5XOc|*5ISk2W=!HPBZWk2#6_Y+Xkri{#EF|ORAR*x z5=C6t7{Nu{xT(7qGZR}y!4YxM2Bl(3i>1c@G$jvwV-AI)wk2U&=%dWDv~9&+2X<0W<=u zz;)oCFuwTZ>=rcm9%u%p5uQcSWa1=~$y_`he=(IxU9u|(Rur!8jyy>m)aSs%g3#aJ z&+|t|X>PvDi7+@gxH>vI`e-JTxo#40D-z}Os6?26Dg!CKtpW9^z=&QlGBQFYlcBDz z&H-6jSz&8yi;azqneOiH3A^(_I(^)bFm&!ZA2kG=1FEX4t65xJq^qmbTMH*oog$mf z^49e9Z~G7IKZK&FOQ=X)SvPz!)&gIH^k~RfY#%po{zZMgTaAA5g#v|qp5w<~zdbWM z^J+0)NP`p|i|6!~It`_1iq z{rDQpjj#+bai&}@8%{A4Gr}5^)WRy#rgAJPEJgWzvH26 z-ikhT75NGzIu5)WG@Z|b+1}RHMmn8-Z)j-fn6uVmr?gi?E2}okp)rJODB8kC4E*+j z4)hOPxp?W~W46QZ?4w}BH-NXxL3|o?B}+?74%H&^hf;KaDtP=?R$VBd?(|iG7JnQD zji%woCniXxQWT3ty?q_H7r12)v-0YVM09p=Lcwd52AwgxrhIJd7_+l!6YFoFT?3gm z85foW5)yg`@DtGFWEK*P`LE@k7J7Pmn46n3`TPnz7(5dKs&>WTqe>doSml!SI(Kt2 znPg#Mfz?$#yd6n>poAAZmz2g^Wme!2@EuUUlhWexI6b|+oI88gUFPQc1i}S-3RF;? zlVt?qGZaskfmpM!si}$K;bCW}777KkRF9~~fo;1DWk4R2j{uhus)Mu1OIn0PB0)zY z!G-yG^7*_0Sq2Ux{O;_tdRhXqnjI0CS1=GhLTaK>XRfuk-^cRuO|mz#cG7}8#zrEM2y1I=tgo*-2bL!rU5=L9B#NAwE@8@p6@fkm zz5-eRZPa~{swyHP6bjpxTAh^FyoT%f_buQw$pmzhFm-4@T0>7k)Vm8D0Dc5&1pWir z)PWV`fNQ`vzz={nrk*+8A??*@Q&(xITGRG4a8%$agv&~y>CqW)d-ApO^(ZtEt?^`w zAy}$Y?fodUvzLG_LAFdcO8d&cSSLXEis<^mz8jjw9|6w+ClOxR>0-I#kzu{md4+xS z0PsCXEvUo56+4()NXQ(!U0wYil{Q8|K17th5Z(av)#jG(r81a37Ub=-@_Pu;YLa@C zI)TWf!*-=x%N`)Yo^_}bs8aB;=j?(&uY#X Date: Mon, 28 Nov 2022 22:15:39 +0530 Subject: [PATCH 0012/1353] Added style for page navigation links(above the footer) --- assets/stylesheets/pages/_sphinx.scss | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/assets/stylesheets/pages/_sphinx.scss b/assets/stylesheets/pages/_sphinx.scss index 64a4df6bb2..cb23ef6922 100644 --- a/assets/stylesheets/pages/_sphinx.scss +++ b/assets/stylesheets/pages/_sphinx.scss @@ -47,6 +47,11 @@ span.descclassname, span.descname { font-family: var(--monoFont) } } +nav[aria-label="Page navigation"]{ + display: flex !important; + justify-content: space-between !important; +} + ._sphinx { @extend %sphinx; } From c3e8ce71899337dd2c7f95a9a77e9b091335e000 Mon Sep 17 00:00:00 2001 From: Vallabh Date: Mon, 28 Nov 2022 22:48:55 +0530 Subject: [PATCH 0013/1353] added link to the icon --- public/icons/docs/wagtail/SOURCE | 1 + 1 file changed, 1 insertion(+) create mode 100644 public/icons/docs/wagtail/SOURCE diff --git a/public/icons/docs/wagtail/SOURCE b/public/icons/docs/wagtail/SOURCE new file mode 100644 index 0000000000..76f5d4b1ac --- /dev/null +++ b/public/icons/docs/wagtail/SOURCE @@ -0,0 +1 @@ +https://github.com/wagtail/wagtail/blob/main/docs/logo.png From 875cccdad28cea94ea97094dde43a197c84510b7 Mon Sep 17 00:00:00 2001 From: Vallabh Date: Mon, 28 Nov 2022 22:49:49 +0530 Subject: [PATCH 0014/1353] added copyright information --- assets/javascripts/templates/pages/about_tmpl.coffee | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 7ca888959e..c7677c3d5c 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -970,7 +970,12 @@ credits = [ '2014-2017 Khronos Group Inc.
Vulkan and the Vulkan logo are registered trademarks of the Khronos Group Inc.', 'CC BY', 'https://creativecommons.org/licenses/by/4.0/' - ], [ + ],[ + 'wagtail', + '2014-present Torchbox Ltd and individual contributors', + 'BSD', + 'https://github.com/wagtail/wagtail/blob/main/LICENSE' + ],[ 'webpack', 'JS Foundation and other contributors', 'CC BY', From 60b4da97c40fb57bc6e928f42503469e3a09ab80 Mon Sep 17 00:00:00 2001 From: Vadim Kazakov Date: Tue, 29 Nov 2022 13:45:26 -0700 Subject: [PATCH 0015/1353] update Ember docs * update Ember 3 to latest 3.x version (3.28) * add Ember 4 documentation to latest LTS (4.4) --- .../templates/pages/about_tmpl.coffee | 2 +- lib/docs/scrapers/ember.rb | 19 ++++++++++++++----- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 7ca888959e..12b6941866 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -297,7 +297,7 @@ credits = [ 'https://raw.githubusercontent.com/elixir-lang/elixir/master/LICENSE' ], [ 'Ember.js', - '2020 Yehuda Katz, Tom Dale and Ember.js contributors', + '2022 Yehuda Katz, Tom Dale and Ember.js contributors', 'MIT', 'https://raw.githubusercontent.com/emberjs/ember.js/master/LICENSE' ], [ diff --git a/lib/docs/scrapers/ember.rb b/lib/docs/scrapers/ember.rb index c5c3ac728d..28c14148cc 100644 --- a/lib/docs/scrapers/ember.rb +++ b/lib/docs/scrapers/ember.rb @@ -42,18 +42,27 @@ class Ember < UrlScraper ] options[:attribution] = <<-HTML - © 2020 Yehuda Katz, Tom Dale and Ember.js contributors
+ © 2022 Yehuda Katz, Tom Dale and Ember.js contributors
Licensed under the MIT License. HTML options[:decode_and_clean_paths] = true # handle paths like @ember/application + version '4' do + self.release = '4.4.0' + self.base_urls = %w[ + https://guides.emberjs.com/v4.4.0/ + https://api.emberjs.com/ember/4.4/ + https://api.emberjs.com/ember-data/4.4/ + ] + end + version '3' do - self.release = '3.25.0' + self.release = '3.28.0' self.base_urls = %w[ - https://guides.emberjs.com/v3.25.0/ - https://api.emberjs.com/ember/3.25/ - https://api.emberjs.com/ember-data/3.25/ + https://guides.emberjs.com/v3.28.0/ + https://api.emberjs.com/ember/3.28/ + https://api.emberjs.com/ember-data/3.28/ ] end From 36e3f453125c86496881ec63f50cb6d81c14cfc8 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 8 Dec 2022 05:51:59 +0000 Subject: [PATCH 0016/1353] chore(deps): update dependency nokogiri to v1.13.10 [security] --- Gemfile.lock | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index d41a93aee0..fcaca392ad 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -55,7 +55,7 @@ GEM net-ssh (>= 5.0.0, < 6.0.0) net-ssh (5.2.0) newrelic_rpm (6.7.0.359) - nokogiri (1.13.9) + nokogiri (1.13.10) mini_portile2 (~> 2.8.0) racc (~> 1.4) options (2.3.2) @@ -66,7 +66,7 @@ GEM pry (0.14.1) coderay (~> 1.1) method_source (~> 1.0) - racc (1.6.0) + racc (1.6.1) rack (2.2.4) rack-protection (2.0.7) rack From cdaff6a5d4bf9267fe2ad1e87f6e92e761361708 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 10 Dec 2022 00:32:51 +0000 Subject: [PATCH 0017/1353] chore(deps): update ruby/setup-ruby action to v1.127.0 --- .github/workflows/build.yml | 2 +- .github/workflows/schedule-doc-report.yml | 2 +- .github/workflows/test.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0893192c45..43106a390d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,7 +13,7 @@ jobs: steps: - uses: actions/checkout@e2f20e631ae6d7dd3b768f56a5d2af784dd54791 # tag=v2.5.0 - name: Set up Ruby - uses: ruby/setup-ruby@c7079efafd956afb5d823e8999c2506e1053aefa # v1.126.0 + uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Run tests diff --git a/.github/workflows/schedule-doc-report.yml b/.github/workflows/schedule-doc-report.yml index fd26aab19b..7a90bc5a73 100644 --- a/.github/workflows/schedule-doc-report.yml +++ b/.github/workflows/schedule-doc-report.yml @@ -10,7 +10,7 @@ jobs: steps: - uses: actions/checkout@e2f20e631ae6d7dd3b768f56a5d2af784dd54791 # tag=v2.5.0 - name: Set up Ruby - uses: ruby/setup-ruby@c7079efafd956afb5d823e8999c2506e1053aefa # v1.126.0 + uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Generate report diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index e9a32789e6..f1f7278778 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -11,7 +11,7 @@ jobs: steps: - uses: actions/checkout@e2f20e631ae6d7dd3b768f56a5d2af784dd54791 # tag=v2.5.0 - name: Set up Ruby - uses: ruby/setup-ruby@c7079efafd956afb5d823e8999c2506e1053aefa # v1.126.0 + uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Run tests From 85bbd1ce6a77e9995432f62cfa43f6bb3b300d30 Mon Sep 17 00:00:00 2001 From: Vadim Kazakov Date: Fri, 16 Dec 2022 13:52:08 -0700 Subject: [PATCH 0018/1353] add qunit documentation scraper --- lib/docs/filters/qunit/clean_html.rb | 12 ++++++++++ lib/docs/filters/qunit/entries.rb | 23 +++++++++++++++++++ lib/docs/scrapers/qunit.rb | 32 +++++++++++++++++++++++++++ public/icons/docs/qunit/16.png | Bin 0 -> 1049 bytes public/icons/docs/qunit/16@2x.png | Bin 0 -> 1623 bytes public/icons/docs/qunit/SOURCE | 1 + 6 files changed, 68 insertions(+) create mode 100644 lib/docs/filters/qunit/clean_html.rb create mode 100644 lib/docs/filters/qunit/entries.rb create mode 100644 lib/docs/scrapers/qunit.rb create mode 100644 public/icons/docs/qunit/16.png create mode 100644 public/icons/docs/qunit/16@2x.png create mode 100644 public/icons/docs/qunit/SOURCE diff --git a/lib/docs/filters/qunit/clean_html.rb b/lib/docs/filters/qunit/clean_html.rb new file mode 100644 index 0000000000..c85daaf86a --- /dev/null +++ b/lib/docs/filters/qunit/clean_html.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +module Docs + class Qunit + class CleanHtmlFilter < Filter + def call + css('.sidebar').remove + doc + end + end + end +end diff --git a/lib/docs/filters/qunit/entries.rb b/lib/docs/filters/qunit/entries.rb new file mode 100644 index 0000000000..43de1c5af8 --- /dev/null +++ b/lib/docs/filters/qunit/entries.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module Docs + class Qunit + class EntriesFilter < Docs::EntriesFilter + TYPE_MAPPING = { + 'QUnit' => '1. Main methods', + 'assert' => '2. Assertions', + 'callbacks' => '3. Callback events', + 'config' => '4. Configuration', + 'extension' => '5. Extension interface' + } + def get_name + at_css('h1').content + end + + def get_type + main, *rest = *slug.split('/') + TYPE_MAPPING[main] + end + end + end +end diff --git a/lib/docs/scrapers/qunit.rb b/lib/docs/scrapers/qunit.rb new file mode 100644 index 0000000000..f7cc13e170 --- /dev/null +++ b/lib/docs/scrapers/qunit.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +module Docs + class Qunit < UrlScraper + self.name = 'QUnit' + self.type = 'qunit' + self.release = '2.19.3' + self.base_url = 'https://api.qunitjs.com/' + self.root_path = '/' + self.links = { + home: 'https://qunitjs.com/', + code: 'https://github.com/qunitjs/qunit' + } + + html_filters.push 'qunit/entries', 'qunit/clean_html' + + options[:trailing_slash] = false + + options[:container] = '.main' + options[:skip_patterns] = [ + /deprecated/, + /^QUnit$/, + /^assert$/, + /^callbacks$/, + /^async$/, + /^config$/, + /^extension$/, + ] + + options[:attribution] = 'Copyright OpenJS Foundation and contributors.' + end +end diff --git a/public/icons/docs/qunit/16.png b/public/icons/docs/qunit/16.png new file mode 100644 index 0000000000000000000000000000000000000000..4d7fdb41bcf094761a570cbfbcb6850626ed1e5d GIT binary patch literal 1049 zcmV+!1m^pRP)EX>4Tx04R}tkv&MmKpe$iQ^gM|3T6;-$WWauii$XD6^c-y)C#RSm|Xe=O&XFE z7e~Rh;NZt%)xpJCR|i)?5c~jfbaGO3krMxx6k5c1aNLh~_a1le0HIc5n$?h)YYU4&=(pZjz4s9B2v0f~5)8KzCVK|H-_ z8=UuvMOKhi;&b9rlP*a7$aTfzH_myN1)eFIspLGdNG#=BSZQHaFg4;S;;^delrN+` zRyl8R)=CxDxF>&MD66k5bDic8Vpzly5|E&vf+9+=5usHl#X^$yqdxvY*PkGlLarhh zITlcc2HEw4|H1EWt=!~=bb{R9X;16O*}U#*53X-)9CL9b7OL+TD+Tr00006VoOIv0RI600RN!9r;`8x010qNS#tmY z4c7nw4c7reD4Tcy000McNliru<_r)NF*zGoY_|Xa0v1U`K~y-)os++7Q&AMhKR55? zz4WCt$xE69`}!*-t=g0#qF6;-0{RCCy1BRrT?9c?9CQ_&;!p%97dHhJp$O`tI5~*a z+NiZqo7hB?CN;Hr_d2BMFPovB>E8Rj_j5Vte2bKgFunsU2 zCh1!zi4De)u0*+twvffK^T$~!t?>2k=N$na05n1B!YHw1oWkrPk1svs!P)y{U(cW! zI?41P9?R1jphtBQM+T5m^7h^va*r0MzN?ab`3WTzZ9zZ66s-Y)(I6eM0L#THxfcuT zqTx3Y0#+(D)T#n)txF2tq!QtCu z7>>Cq1)moXn0^y2pdoaD7S`w-h~m~==3dRxeC7pXa%D7KBis|Awp7E4`3dX^@^NyC&XE|U{4d;6eFKo2{LcKDd7PAklj?@yrmMgT zS#*!};`JFsk`V&&Acb!QWToLQG0~S%O&<)N+lSq2cKIi@@c-1Tv^R T2uiB-00000NkvXXu0mjf!CT(T literal 0 HcmV?d00001 diff --git a/public/icons/docs/qunit/16@2x.png b/public/icons/docs/qunit/16@2x.png new file mode 100644 index 0000000000000000000000000000000000000000..b9ae2d2ff64fa520c6f54013bfcdefd77a055128 GIT binary patch literal 1623 zcmV-d2B`UoP)EX>4Tx04R}tkv&MmKpe$iQ^gM|3T6;-$WWauii$XD6^c-y)C#RSm|Xe=O&XFE z7e~Rh;NZt%)xpJCR|i)?5c~jfbaGO3krMxx6k5c1aNLh~_a1le0HIc5n$?h)YYU4&=(pZjz4s9B2v0f~5)8KzCVK|H-_ z8=UuvMOKhi;&b9rlP*a7$aTfzH_myN1)eFIspLGdNG#=BSZQHaFg4;S;;^delrN+` zRyl8R)=CxDxF>&MD66k5bDic8Vpzly5|E&vf+9+=5usHl#X^$yqdxvY*PkGlLarhh zITlcc2HEw4|H1EWt=!~=bb{R9X;16O*}U#*53X-)9CL9b7OL+TD+Tr00006VoOIv0RI600RN!9r;`8x010qNS#tmY z4c7nw4c7reD4Tcy000McNliru<_r)NF(7|D#CHGy1XM{xK~z}7#g#hbX1Y5&XhIT1*g+0kUobNK{|DDVK9C4`qpbWeO z><3l=68BdMz!31BDVbl&z&_yP2VnR=aR3{DFC-gZ`OUrBwa0k`6&kS~x)rilzhxYR$4Hk@6w zAH|{egB70<>_rXqrtAiDd1E@hC z&%V_|us8Jo0jTR#=zg;YkKbckw@eE|H?VGty-Rho<<+f-MZ`g#kEgaAcoH?JmX>mv z9D~Px<*y?b(WW$%`JtptS$$kuBFw7pkwD6WRJ6?Up@0TV@F2kWVx9&xppyP zTl0l|)d3J5LEB?(wwMon{#%i~=ivoCrQh~9Q5^tZr=R+khLWC|m?3sLR`IgOXHU}X zjdXPYTKksSN-i;xz|zfmFIstv#&DplTNd%Fu_~&-f`-;cTdb3#(@=q?oQ+PFtXxvk z^`u7pmpE9Ubg9USOy)`kBc2BVYL^d(*FpOC6a}p?*8^6;LTONJM)ZVU5qaab0A7Dx zNso`k(MGa3oDTX9zQFFods*5WF1|A0WY>{B?D}jE-qyMbAuvJqI&GWodUr(tOE-jZ zxXRfX85l>n1m4a%lz;*PQdegH2yF@BY4noU4YJoW6#z(3m@U{gTQ;^L++yC$X??sr zMigcZE+4%FfPcLom+D5(Xr#}jinRVz3qlB{uO%=wbN(C<4ncZ4W!nsOG_&oKZic_P zh(4*8@(0pq9sVcm}P zs!)FP06`N9WB8hMc1cJsD#cG-Q^TwUa zFmi01*yZTlL$ZWZah1MXjRW|@ep(-0h9!fiuE-6ux{g(_P&fMUsvdIb9Mgk|I|HzE zlb=5Pk#zLl2}PUHNS>NTPZuj^ZTC8!>)*lC?>vJ`aigU*Qs-wD?uPN>QNE6R#pXAj zAl%i0yUvZn>9F?#i#aVhHWDSD$T9HgIn*Wanq=N2{b=To_R z?*+9GspznpNnQfZ*AT#I39NSky#~fpzyZmS%@C@?Qj$ VeJRk;Tde>9002ovPDHLkV1njj{3iea literal 0 HcmV?d00001 diff --git a/public/icons/docs/qunit/SOURCE b/public/icons/docs/qunit/SOURCE new file mode 100644 index 0000000000..560740c280 --- /dev/null +++ b/public/icons/docs/qunit/SOURCE @@ -0,0 +1 @@ +https://raw.githubusercontent.com/qunitjs/qunitjs.com/main/img/logo.svg From e7a40453c32c9e651342f92de90f833b61e673e9 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 17 Dec 2022 01:19:55 +0000 Subject: [PATCH 0019/1353] chore(deps): update actions/checkout action to v2.6.0 --- .github/workflows/build.yml | 2 +- .github/workflows/schedule-doc-report.yml | 2 +- .github/workflows/test.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 43106a390d..73687b6239 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-20.04 if: github.repository == 'freeCodeCamp/devdocs' steps: - - uses: actions/checkout@e2f20e631ae6d7dd3b768f56a5d2af784dd54791 # tag=v2.5.0 + - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0 with: diff --git a/.github/workflows/schedule-doc-report.yml b/.github/workflows/schedule-doc-report.yml index 7a90bc5a73..d5679b357d 100644 --- a/.github/workflows/schedule-doc-report.yml +++ b/.github/workflows/schedule-doc-report.yml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-20.04 if: github.repository == 'freeCodeCamp/devdocs' steps: - - uses: actions/checkout@e2f20e631ae6d7dd3b768f56a5d2af784dd54791 # tag=v2.5.0 + - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0 with: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index f1f7278778..4b5ff640e1 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -9,7 +9,7 @@ jobs: test: runs-on: ubuntu-20.04 steps: - - uses: actions/checkout@e2f20e631ae6d7dd3b768f56a5d2af784dd54791 # tag=v2.5.0 + - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0 with: From 855197807f29c5e1561390ac73915c2f236b2c29 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 22:19:30 +0100 Subject: [PATCH 0020/1353] Update Git documentation (2.39.0) --- lib/docs/scrapers/git.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/docs/scrapers/git.rb b/lib/docs/scrapers/git.rb index ba3efe02bf..a5de307a64 100644 --- a/lib/docs/scrapers/git.rb +++ b/lib/docs/scrapers/git.rb @@ -1,7 +1,7 @@ module Docs class Git < UrlScraper self.type = 'git' - self.release = '2.38.0' + self.release = '2.39.0' self.base_url = 'https://git-scm.com/docs' self.initial_paths = %w(/git.html) self.links = { From 50703ecb51740243fa71ff8c5b981b8eef192e45 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 22:42:15 +0100 Subject: [PATCH 0021/1353] erlang: clean .innertube --- lib/docs/filters/erlang/clean_html.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/docs/filters/erlang/clean_html.rb b/lib/docs/filters/erlang/clean_html.rb index a467515a8a..5b54667dc1 100644 --- a/lib/docs/filters/erlang/clean_html.rb +++ b/lib/docs/filters/erlang/clean_html.rb @@ -2,7 +2,7 @@ module Docs class Erlang class CleanHtmlFilter < Filter def call - @doc = at_css('#content') + @doc = at_css('#content .innertube', '#content') # frontpage From 624ac21c26c2506407d20bfb0ffd607b8abee5f7 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 22:48:47 +0100 Subject: [PATCH 0022/1353] Update Wagtail documentation (4.1.1) --- lib/docs/filters/wagtail/clean_html.rb | 2 + lib/docs/scrapers/wagtail.rb | 67 +++----------------------- 2 files changed, 8 insertions(+), 61 deletions(-) diff --git a/lib/docs/filters/wagtail/clean_html.rb b/lib/docs/filters/wagtail/clean_html.rb index b5b28b5368..050388d578 100644 --- a/lib/docs/filters/wagtail/clean_html.rb +++ b/lib/docs/filters/wagtail/clean_html.rb @@ -2,6 +2,8 @@ module Docs class Wagtail class CleanHtmlFilter < Filter def call + @doc = at_css('main > section', 'main') + # footer contains links like about,contact us etc which # are not needed in documentation so removed doc.search('footer').each do |footer| diff --git a/lib/docs/scrapers/wagtail.rb b/lib/docs/scrapers/wagtail.rb index 891639d499..bc9d626d47 100644 --- a/lib/docs/scrapers/wagtail.rb +++ b/lib/docs/scrapers/wagtail.rb @@ -25,74 +25,19 @@ class Wagtail < UrlScraper ] # updating release and base_url for different versions - version 'stable' do - self.release = 'stable' + version do + self.release = '4.1.1' self.base_url = 'https://docs.wagtail.org/en/stable/' end - version 'latest' do - self.release = 'latest' - self.base_url = 'https://docs.wagtail.org/en/latest/' - end - - version '4.0.4' do - self.release = '4.0.4' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" - end - - version '4.0' do - self.release = '4.0' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" - end - - version '3.0.3' do + version '3' do self.release = '3.0.3' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" + self.base_url = "https://docs.wagtail.org/en/v#{release}/" end - version '2.16.3' do + version '2' do self.release = '2.16.3' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" - end - - version '2.15.6' do - self.release = '2.15.6' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" - end - - version '2.10.2' do - self.release = '2.10.2' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" - end - - version '2.5.2' do - self.release = '2.5.2' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" - end - - version '2.4' do - self.release = '2.4' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" - end - - version '2.3' do - self.release = '2.3' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" - end - - version '2.0.2' do - self.release = '2.0.2' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" - end - - version '1.2' do - self.release = '1.2' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" - end - - version '1.1' do - self.release = '1.1' - self.base_url = "https://docs.wagtail.org/en/v#{version}/" + self.base_url = "https://docs.wagtail.org/en/v#{release}/" end # this method will fetch the latest version of wagtail From 10c9f72ecb213fd7a81337099daab0c3fa351445 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 22:53:19 +0100 Subject: [PATCH 0023/1353] Update Ember.js documentation (4.9.0) --- lib/docs/scrapers/ember.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/docs/scrapers/ember.rb b/lib/docs/scrapers/ember.rb index 28c14148cc..78b2ebb2d8 100644 --- a/lib/docs/scrapers/ember.rb +++ b/lib/docs/scrapers/ember.rb @@ -49,11 +49,11 @@ class Ember < UrlScraper options[:decode_and_clean_paths] = true # handle paths like @ember/application version '4' do - self.release = '4.4.0' + self.release = '4.9.0' self.base_urls = %w[ - https://guides.emberjs.com/v4.4.0/ - https://api.emberjs.com/ember/4.4/ - https://api.emberjs.com/ember-data/4.4/ + https://guides.emberjs.com/v4.9.0/ + https://api.emberjs.com/ember/4.9/ + https://api.emberjs.com/ember-data/4.9/ ] end From faac2369cd580f355ce63b35ec8ac26de73edb26 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 22:59:39 +0100 Subject: [PATCH 0024/1353] Update QUnit documentation (2.19.3) --- assets/javascripts/templates/pages/about_tmpl.coffee | 5 +++++ lib/docs/filters/qunit/clean_html.rb | 1 + lib/docs/scrapers/qunit.rb | 9 ++++++++- 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 7ca888959e..c9f07e1980 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -745,6 +745,11 @@ credits = [ '2012-2018 The Qt Company Ltd', 'GFDL', 'https://doc.qt.io/qt-5/licensing.html' + ], [ + 'QUnit', + 'OpenJS Foundation and other contributors', + 'MIT', + 'https://raw.githubusercontent.com/qunitjs/qunit/main/LICENSE.txt' ], [ 'R', '1999–2012 R Foundation for Statistical Computing', diff --git a/lib/docs/filters/qunit/clean_html.rb b/lib/docs/filters/qunit/clean_html.rb index c85daaf86a..201c30b66c 100644 --- a/lib/docs/filters/qunit/clean_html.rb +++ b/lib/docs/filters/qunit/clean_html.rb @@ -4,6 +4,7 @@ module Docs class Qunit class CleanHtmlFilter < Filter def call + @doc = at_css('.content[role="main"]') css('.sidebar').remove doc end diff --git a/lib/docs/scrapers/qunit.rb b/lib/docs/scrapers/qunit.rb index f7cc13e170..f0d649f503 100644 --- a/lib/docs/scrapers/qunit.rb +++ b/lib/docs/scrapers/qunit.rb @@ -27,6 +27,13 @@ class Qunit < UrlScraper /^extension$/, ] - options[:attribution] = 'Copyright OpenJS Foundation and contributors.' + options[:attribution] = <<-HTML + © OpenJS Foundation and contributors.
+ Licensed under the MIT license. + HTML + + def get_latest_version(opts) + get_npm_version('qunit', opts) + end end end From 1d0ffffd43b5d06624acc66f6aeb9d352a87887a Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:00:52 +0100 Subject: [PATCH 0025/1353] Update QUnit documentation (2.19.3) --- lib/docs/filters/qunit/clean_html.rb | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/docs/filters/qunit/clean_html.rb b/lib/docs/filters/qunit/clean_html.rb index 201c30b66c..eb104b5ce6 100644 --- a/lib/docs/filters/qunit/clean_html.rb +++ b/lib/docs/filters/qunit/clean_html.rb @@ -6,6 +6,10 @@ class CleanHtmlFilter < Filter def call @doc = at_css('.content[role="main"]') css('.sidebar').remove + css('pre').each do |node| + node['data-language'] = 'javascript' + node.content = node.content + end doc end end From cb0913d29746acda416d533074bfceaf082ef7ec Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:04:49 +0100 Subject: [PATCH 0026/1353] qunit, wagtail: add news entry --- assets/javascripts/news.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/assets/javascripts/news.json b/assets/javascripts/news.json index df52090bf3..7e24f0957f 100644 --- a/assets/javascripts/news.json +++ b/assets/javascripts/news.json @@ -1,4 +1,8 @@ [ + [ + "2022-12-20", + "New documentations: QUnit, Wagtail" + ], [ "2022-11-04", "New documentation: VueUse" From 0e7a169616061e2a6c0ef35e49e3c4a75a100405 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:08:17 +0100 Subject: [PATCH 0027/1353] Update Vite documentation (4.0.2) --- lib/docs/scrapers/vite.rb | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/lib/docs/scrapers/vite.rb b/lib/docs/scrapers/vite.rb index 46b56c2a68..eec424536b 100644 --- a/lib/docs/scrapers/vite.rb +++ b/lib/docs/scrapers/vite.rb @@ -17,11 +17,19 @@ class Vite < UrlScraper options[:skip] = %w(team.html plugins/) - self.release = '3.2.2' - self.base_url = 'https://vitejs.dev/' self.initial_paths = %w(guide/) html_filters.push 'vite/entries', 'vite/clean_html' + version do + self.release = '4.0.2' + self.base_url = 'https://vitejs.dev/' + end + + version '3' do + self.release = '3.2.5' + self.base_url = 'https://v3.vitejs.dev/' + end + def get_latest_version(opts) get_npm_version('vite', opts) end From 46141327a9c50cfbb0ff6b6869e4ac0566343c54 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:09:35 +0100 Subject: [PATCH 0028/1353] Update Vitest documentation (0.26.1) --- lib/docs/scrapers/vitest.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/docs/scrapers/vitest.rb b/lib/docs/scrapers/vitest.rb index 1f3c700e4d..c85798efb4 100644 --- a/lib/docs/scrapers/vitest.rb +++ b/lib/docs/scrapers/vitest.rb @@ -16,7 +16,7 @@ class Vitest < UrlScraper Licensed under the MIT License. HTML - self.release = '0.25.1' + self.release = '0.26.1' self.base_url = 'https://vitest.dev/' self.initial_paths = %w(guide/) html_filters.push 'vitest/entries', 'vite/clean_html' From 727fa3b0a8bc2eb645d63993394d574858a4d351 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:11:31 +0100 Subject: [PATCH 0029/1353] Update Astro documentation (1.7.2) --- lib/docs/scrapers/astro.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/docs/scrapers/astro.rb b/lib/docs/scrapers/astro.rb index 7529bc5f72..2d6795d05f 100644 --- a/lib/docs/scrapers/astro.rb +++ b/lib/docs/scrapers/astro.rb @@ -16,7 +16,7 @@ class Astro < UrlScraper options[:skip_patterns] = [/tutorial/] - self.release = '1.6.3' + self.release = '1.7.2' self.base_url = 'https://docs.astro.build/en/' self.initial_paths = %w(getting-started/) From 55556fe1e749b9e1a7dea9e84a3435c0398633a7 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:12:22 +0100 Subject: [PATCH 0030/1353] Update Axios documentation (1.2.1) --- lib/docs/scrapers/axios.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/docs/scrapers/axios.rb b/lib/docs/scrapers/axios.rb index ed1d63f29f..65e2628116 100755 --- a/lib/docs/scrapers/axios.rb +++ b/lib/docs/scrapers/axios.rb @@ -5,7 +5,7 @@ class Axios < UrlScraper home: 'hthttps://axios-http.com/', code: 'https://github.com/axios/axios' } - self.release = '1.1.3' + self.release = '1.2.1' self.base_url = "https://axios-http.com/docs/" self.initial_paths = %w(index intro) From 3e627cdae1c6253287d5f771383c07ec9c95e7a1 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:16:56 +0100 Subject: [PATCH 0031/1353] =?UTF-8?q?l=C3=B6ve:=20add=20alias=20"k8s"?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes #1885. --- assets/javascripts/models/entry.coffee | 1 + 1 file changed, 1 insertion(+) diff --git a/assets/javascripts/models/entry.coffee b/assets/javascripts/models/entry.coffee index 3ce1753582..2d07c1599c 100644 --- a/assets/javascripts/models/entry.coffee +++ b/assets/javascripts/models/entry.coffee @@ -61,6 +61,7 @@ class app.models.Entry extends app.Model 'julia': 'jl' 'jquery': '$' 'knockout.js': 'ko' + 'kubernetes': 'k8s' 'less': 'ls' 'lodash': '_' 'löve': 'love' From 979c8a32ae0b2b67558adc917d39412c98fffb58 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:17:38 +0100 Subject: [PATCH 0032/1353] Update PHP documentation (8.2) --- assets/javascripts/templates/pages/about_tmpl.coffee | 2 +- lib/docs/scrapers/php.rb | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 46930e8e7a..74b036ebae 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -687,7 +687,7 @@ credits = [ 'https://raw.githubusercontent.com/phoenixframework/phoenix/master/LICENSE.md' ], [ 'PHP', - '1997-2021 The PHP Documentation Group', + '1997-2022 The PHP Documentation Group', 'CC BY', 'https://secure.php.net/manual/en/copyright.php' ], [ diff --git a/lib/docs/scrapers/php.rb b/lib/docs/scrapers/php.rb index 6facd0c914..5c02d6c5f2 100644 --- a/lib/docs/scrapers/php.rb +++ b/lib/docs/scrapers/php.rb @@ -5,7 +5,7 @@ class Php < FileScraper self.name = 'PHP' self.type = 'php' - self.release = '8.1.5' + self.release = '8.2' self.base_url = 'https://www.php.net/manual/en/' self.root_path = 'index.html' self.initial_paths = %w( @@ -62,7 +62,7 @@ class Php < FileScraper options[:skip_patterns] = [/mysqlnd/, /xdevapi/i] options[:attribution] = <<-HTML - © 1997–2021 The PHP Documentation Group
+ © 1997–2022 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later. HTML From 9e5205cfaf8d143d066bb3a709a4e27cdc25e5b1 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:20:54 +0100 Subject: [PATCH 0033/1353] Update ESLint documentation (8.30.0) --- lib/docs/filters/eslint/clean_html.rb | 3 +++ lib/docs/scrapers/eslint.rb | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/docs/filters/eslint/clean_html.rb b/lib/docs/filters/eslint/clean_html.rb index 9bc18709da..0737acef05 100644 --- a/lib/docs/filters/eslint/clean_html.rb +++ b/lib/docs/filters/eslint/clean_html.rb @@ -13,6 +13,7 @@ def call node.before(node.children).remove end + css('.line-numbers-wrapper').remove css('pre.hljs').each do |node| lang = node['class'][/highlight-(\w+)/, 1] node['data-language'] = lang if lang @@ -23,6 +24,8 @@ def call css('code', 'p').remove_attr('class') + css('.resource__image', '.resource__domain').remove + doc end end diff --git a/lib/docs/scrapers/eslint.rb b/lib/docs/scrapers/eslint.rb index 0395071e81..4a2d7bcb0e 100644 --- a/lib/docs/scrapers/eslint.rb +++ b/lib/docs/scrapers/eslint.rb @@ -2,7 +2,7 @@ module Docs class Eslint < UrlScraper self.name = 'ESLint' self.type = 'simple' - self.release = '8.23.0' + self.release = '8.30.0' self.base_url = 'https://eslint.org/docs/latest/' self.root_path = 'user-guide/getting-started' self.links = { From 8e65fcb713a44a795ae0c4984f170f5a28886507 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:22:59 +0100 Subject: [PATCH 0034/1353] Update HAProxy documentation (2.7.0) --- lib/docs/scrapers/haproxy.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/docs/scrapers/haproxy.rb b/lib/docs/scrapers/haproxy.rb index 8c9349a009..8fb07165e3 100644 --- a/lib/docs/scrapers/haproxy.rb +++ b/lib/docs/scrapers/haproxy.rb @@ -20,6 +20,11 @@ class Haproxy < UrlScraper Licensed under the GNU General Public License version 2. HTML + version '2.7' do + self.release = '2.7.0' + self.base_url = "https://docs.haproxy.org/#{self.version}/" + end + version '2.6' do self.release = '2.6.5' self.base_url = "https://docs.haproxy.org/#{self.version}/" From 5ff801d306469d3e75da9afbd866ba2d3b917e72 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:26:02 +0100 Subject: [PATCH 0035/1353] Update HAProxy documentation (2.7.0) --- lib/docs/filters/haproxy/clean_html.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/docs/filters/haproxy/clean_html.rb b/lib/docs/filters/haproxy/clean_html.rb index 78f8e81844..7a0b3c1474 100755 --- a/lib/docs/filters/haproxy/clean_html.rb +++ b/lib/docs/filters/haproxy/clean_html.rb @@ -29,8 +29,9 @@ def call node['id'] = node.at_css('.anchor')['name'] end - css('.keyword > b').each do |node| + css('.keyword > b', '.keyword > span').each do |node| node.content = node.content + node.remove_attribute('style') end css('.dropdown').each do |node| From 9fd2dde566189312f9619c1c97ef20341db50a78 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Tue, 20 Dec 2022 23:29:43 +0100 Subject: [PATCH 0036/1353] Update VueUse documentation (9.8.2) --- lib/docs/scrapers/vueuse.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/docs/scrapers/vueuse.rb b/lib/docs/scrapers/vueuse.rb index 4f8d5a4a65..70f0935f12 100644 --- a/lib/docs/scrapers/vueuse.rb +++ b/lib/docs/scrapers/vueuse.rb @@ -22,13 +22,13 @@ class Vueuse < UrlScraper Licensed under the MIT License. HTML - self.release = '9.4.0' + self.release = '9.8.2' self.base_url = 'https://vueuse.org/' self.initial_paths = %w(functions.html) html_filters.push 'vueuse/entries', 'vite/clean_html', 'vueuse/clean_html' def get_latest_version(opts) - get_npm_version('vueuse', opts) + get_npm_version('@vueuse/core', opts) end end end From be2148bc6cfa12ad2b09a2b28cceaaa10ffa234a Mon Sep 17 00:00:00 2001 From: Vadim Kazakov Date: Wed, 21 Dec 2022 09:50:32 -0700 Subject: [PATCH 0037/1353] update sinon scraper add newer versions and update scraper urls --- lib/docs/scrapers/sinon.rb | 76 ++++++++++++-------------------------- 1 file changed, 23 insertions(+), 53 deletions(-) diff --git a/lib/docs/scrapers/sinon.rb b/lib/docs/scrapers/sinon.rb index a8a75f2d61..2945b6fe40 100644 --- a/lib/docs/scrapers/sinon.rb +++ b/lib/docs/scrapers/sinon.rb @@ -14,7 +14,7 @@ class Sinon < UrlScraper options[:container] = '.content .container' options[:attribution] = <<-HTML - © 2010–2021 Christian Johansen
+ © 2010–2022 Christian Johansen
Licensed under the BSD License. HTML @@ -27,59 +27,29 @@ class Sinon < UrlScraper url end - version '11' do - self.release = '11.1.2' - self.base_url = "https://sinonjs.org/releases/v#{release}/" - end - - version '10' do - self.release = '10.0.1' - self.base_url = "https://sinonjs.org/releases/v#{release}/" - end - - version '9' do - self.release = '9.2.2' - self.base_url = "https://sinonjs.org/releases/v#{release}/" - end - - version '8' do - self.release = '8.1.1' - self.base_url = "https://sinonjs.org/releases/v#{release}/" - end - - version '7' do - self.release = '7.5.0' - self.base_url = "https://sinonjs.org/releases/v#{release}/" - end - - version '6' do - self.release = '6.3.5' - self.base_url = "https://sinonjs.org/releases/v#{release}/" - end - - version '5' do - self.release = '5.1.0' - self.base_url = "https://sinonjs.org/releases/v#{release}/" - end - - version '4' do - self.release = '4.5.0' - self.base_url = "https://sinonjs.org/releases/v#{release}/" - end - - version '3' do - self.release = '3.3.0' - self.base_url = "https://sinonjs.org/releases/v#{release}/" - end - - version '2' do - self.release = '2.4.1' - self.base_url = "https://sinonjs.org/releases/v#{release}/" - end + RELEASE_MAPPINGS = { + '15' => '15.0.1', + '14' => '14.0.2', + '13' => '13.0.1', + '12' => '12.0.1', + '11' => '11.1.2', + '10' => '10.0.1', + '9' => '9.2.2.', + '8' => '8.1.1', + '7' => '7.5.0', + '6' => '6.3.5', + '5' => '5.1.0', + '4' => '4.5.0', + '3' => '3.3.0', + '2' => '2.4.1', + '1' => '1.17.7' + } - version '1' do - self.release = '1.17.7' - self.base_url = "https://sinonjs.org/releases/v#{release}/" + RELEASE_MAPPINGS.each do |ver, release| + version ver do + self.release = release + self.base_url = "https://sinonjs.org/releases/v#{ver}/" + end end def get_latest_version(opts) From df49637967ccfba5101144db066bda8c575fd0ad Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 24 Dec 2022 00:44:53 +0000 Subject: [PATCH 0038/1353] chore(deps): update ruby/setup-ruby action to v1.128.0 --- .github/workflows/build.yml | 2 +- .github/workflows/schedule-doc-report.yml | 2 +- .github/workflows/test.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 73687b6239..1867106c6a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,7 +13,7 @@ jobs: steps: - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby - uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0 + uses: ruby/setup-ruby@4b2d1d631efa087f8896c15a0c6023dc2f483198 # v1.128.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Run tests diff --git a/.github/workflows/schedule-doc-report.yml b/.github/workflows/schedule-doc-report.yml index d5679b357d..ee5d276e82 100644 --- a/.github/workflows/schedule-doc-report.yml +++ b/.github/workflows/schedule-doc-report.yml @@ -10,7 +10,7 @@ jobs: steps: - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby - uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0 + uses: ruby/setup-ruby@4b2d1d631efa087f8896c15a0c6023dc2f483198 # v1.128.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Generate report diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 4b5ff640e1..c5fcd142a7 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -11,7 +11,7 @@ jobs: steps: - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby - uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0 + uses: ruby/setup-ruby@4b2d1d631efa087f8896c15a0c6023dc2f483198 # v1.128.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Run tests From b2965ccd413a6b59eab7980ef8e2fe9cbb1309f7 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Sun, 25 Dec 2022 11:06:33 +0100 Subject: [PATCH 0039/1353] Update esbuild documentation (0.16.10) --- lib/docs/scrapers/esbuild.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/docs/scrapers/esbuild.rb b/lib/docs/scrapers/esbuild.rb index 22f95e77a3..b65fcc2c9b 100644 --- a/lib/docs/scrapers/esbuild.rb +++ b/lib/docs/scrapers/esbuild.rb @@ -16,7 +16,7 @@ class Esbuild < UrlScraper Licensed under the MIT License. HTML - self.release = '0.15.7' + self.release = '0.16.10' self.base_url = 'https://esbuild.github.io/' html_filters.push 'esbuild/clean_html', 'esbuild/entries' From 90e04e29dc19f9c2be0f07e80159f95b864fa7b0 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Sun, 25 Dec 2022 11:07:45 +0100 Subject: [PATCH 0040/1353] Update FastAPI documentation (0.88.0) --- lib/docs/scrapers/fastapi.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/docs/scrapers/fastapi.rb b/lib/docs/scrapers/fastapi.rb index 682c4a4003..760603b955 100644 --- a/lib/docs/scrapers/fastapi.rb +++ b/lib/docs/scrapers/fastapi.rb @@ -2,7 +2,7 @@ module Docs class Fastapi < UrlScraper self.name = 'FastAPI' self.type = 'fastapi' - self.release = '0.86.0' + self.release = '0.88.0' self.base_url = 'https://fastapi.tiangolo.com/' self.root_path = '/' self.links = { From b614a2c110518f7c253c64782f8c126b972b6def Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Sun, 25 Dec 2022 11:17:24 +0100 Subject: [PATCH 0041/1353] Update OCaml documentation (5.0) --- lib/docs/scrapers/ocaml.rb | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/lib/docs/scrapers/ocaml.rb b/lib/docs/scrapers/ocaml.rb index 0ab64a90ec..c26572ac22 100644 --- a/lib/docs/scrapers/ocaml.rb +++ b/lib/docs/scrapers/ocaml.rb @@ -3,8 +3,6 @@ class Ocaml < FileScraper self.name = 'OCaml' self.type = 'ocaml' self.root_path = 'index.html' - self.release = '4.14' - self.base_url = "https://v2.ocaml.org/releases/#{self.release}/htmlman/" self.links = { home: 'https://ocaml.org/', code: 'https://github.com/ocaml/ocaml' @@ -26,6 +24,16 @@ class Ocaml < FileScraper © 1995-2022 INRIA. HTML + version '' do + self.release = '5.0' + self.base_url = "https://v2.ocaml.org/releases/#{self.release}/htmlman/" + end + + version '4.14' do + self.release = '4.14' + self.base_url = "https://v2.ocaml.org/releases/#{self.release}/htmlman/" + end + def get_latest_version(opts) get_latest_github_release('ocaml', 'ocaml', opts) end From 072b0e00809f41fcc5f1151225ba3b456ef13746 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Sun, 25 Dec 2022 11:20:53 +0100 Subject: [PATCH 0042/1353] Update Kubectl documentation (1.26) --- lib/docs/scrapers/kubectl.rb | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/lib/docs/scrapers/kubectl.rb b/lib/docs/scrapers/kubectl.rb index 9e33a27cae..42cff8c754 100644 --- a/lib/docs/scrapers/kubectl.rb +++ b/lib/docs/scrapers/kubectl.rb @@ -7,7 +7,6 @@ class Kubectl < UrlScraper home: 'https://kubernetes.io/docs/reference/kubectl/', code: 'https://github.com/kubernetes/kubernetes' } - self.release = "1.23" self.base_url = "https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands" html_filters.push 'kubectl/entries', 'kubectl/clean_html' @@ -21,7 +20,7 @@ class Kubectl < UrlScraper # latest version has a special URL that does not include the version identifier version do - self.release = "1.25" + self.release = "1.26" self.base_url = "https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands" end From 0785baf334352775c5af2dc718cf5a954a1037dd Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Sun, 25 Dec 2022 11:21:21 +0100 Subject: [PATCH 0043/1353] Update Kubernetes documentation (1.26) --- lib/docs/scrapers/kubernetes.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/docs/scrapers/kubernetes.rb b/lib/docs/scrapers/kubernetes.rb index 4b0aa323ca..2eb30c6331 100644 --- a/lib/docs/scrapers/kubernetes.rb +++ b/lib/docs/scrapers/kubernetes.rb @@ -20,7 +20,7 @@ class Kubernetes < UrlScraper # latest version has a special URL that does not include the version identifier version do - self.release = "1.25" + self.release = "1.26" self.base_url = "https://kubernetes.io/docs/reference/kubernetes-api/" end From d108b1cb9eef0c8758123efa2cea77bdb3c28e1d Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Sun, 25 Dec 2022 11:24:30 +0100 Subject: [PATCH 0044/1353] Update Immutable.js documentation (4.2.1) --- lib/docs/scrapers/immutable.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/docs/scrapers/immutable.rb b/lib/docs/scrapers/immutable.rb index 74e7dee1cf..f4266923ee 100644 --- a/lib/docs/scrapers/immutable.rb +++ b/lib/docs/scrapers/immutable.rb @@ -3,7 +3,7 @@ class Immutable < UrlScraper self.name = 'Immutable.js' self.slug = 'immutable' self.type = 'simple' - self.release = '4.1.0' + self.release = '4.2.1' self.base_url = "https://immutable-js.com/docs/v#{release}/" self.links = { home: 'https://immutable-js.com/', From 2de33e7014e56ec25eb36e2d5fc66465ee195b4b Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Sun, 25 Dec 2022 11:25:22 +0100 Subject: [PATCH 0045/1353] Update Bootstrap documentation (5.3) --- lib/docs/scrapers/bootstrap.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/docs/scrapers/bootstrap.rb b/lib/docs/scrapers/bootstrap.rb index 4719b465ec..fac525c1a4 100644 --- a/lib/docs/scrapers/bootstrap.rb +++ b/lib/docs/scrapers/bootstrap.rb @@ -17,7 +17,7 @@ class Bootstrap < UrlScraper HTML version '5' do - self.release = '5.2' + self.release = '5.3' self.base_url = "https://getbootstrap.com/docs/#{self.release}/" self.root_path = 'getting-started/introduction/' From 398123ca954acfe2ca43629fd9bce28f30dd142c Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sun, 25 Dec 2022 13:19:10 +0000 Subject: [PATCH 0046/1353] chore(deps): update ruby/setup-ruby action to v1.130.0 --- .github/workflows/build.yml | 2 +- .github/workflows/schedule-doc-report.yml | 2 +- .github/workflows/test.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1867106c6a..97ec87d8b1 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,7 +13,7 @@ jobs: steps: - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby - uses: ruby/setup-ruby@4b2d1d631efa087f8896c15a0c6023dc2f483198 # v1.128.0 + uses: ruby/setup-ruby@02c9cccf0e6febba967b63f90fac9f8376ce905d # v1.130.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Run tests diff --git a/.github/workflows/schedule-doc-report.yml b/.github/workflows/schedule-doc-report.yml index ee5d276e82..4824c15661 100644 --- a/.github/workflows/schedule-doc-report.yml +++ b/.github/workflows/schedule-doc-report.yml @@ -10,7 +10,7 @@ jobs: steps: - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby - uses: ruby/setup-ruby@4b2d1d631efa087f8896c15a0c6023dc2f483198 # v1.128.0 + uses: ruby/setup-ruby@02c9cccf0e6febba967b63f90fac9f8376ce905d # v1.130.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Generate report diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index c5fcd142a7..9194f5b441 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -11,7 +11,7 @@ jobs: steps: - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby - uses: ruby/setup-ruby@4b2d1d631efa087f8896c15a0c6023dc2f483198 # v1.128.0 + uses: ruby/setup-ruby@02c9cccf0e6febba967b63f90fac9f8376ce905d # v1.130.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Run tests From 38b977e8fb1fd9627ada1581df25f219c73a6acd Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sun, 25 Dec 2022 21:07:00 +0000 Subject: [PATCH 0047/1353] chore(deps): update ruby/setup-ruby action to v1.131.0 --- .github/workflows/build.yml | 2 +- .github/workflows/schedule-doc-report.yml | 2 +- .github/workflows/test.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 97ec87d8b1..85741809c0 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,7 +13,7 @@ jobs: steps: - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby - uses: ruby/setup-ruby@02c9cccf0e6febba967b63f90fac9f8376ce905d # v1.130.0 + uses: ruby/setup-ruby@03b78bdda287ae04217ee12e4b64996630a03542 # v1.131.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Run tests diff --git a/.github/workflows/schedule-doc-report.yml b/.github/workflows/schedule-doc-report.yml index 4824c15661..3630fb4580 100644 --- a/.github/workflows/schedule-doc-report.yml +++ b/.github/workflows/schedule-doc-report.yml @@ -10,7 +10,7 @@ jobs: steps: - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby - uses: ruby/setup-ruby@02c9cccf0e6febba967b63f90fac9f8376ce905d # v1.130.0 + uses: ruby/setup-ruby@03b78bdda287ae04217ee12e4b64996630a03542 # v1.131.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Generate report diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 9194f5b441..480d93046f 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -11,7 +11,7 @@ jobs: steps: - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 # v2.6.0 - name: Set up Ruby - uses: ruby/setup-ruby@02c9cccf0e6febba967b63f90fac9f8376ce905d # v1.130.0 + uses: ruby/setup-ruby@03b78bdda287ae04217ee12e4b64996630a03542 # v1.131.0 with: bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Run tests From c595540524bb57fda1b012cdde00d69dfd9d836c Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Mon, 26 Dec 2022 17:39:49 +0100 Subject: [PATCH 0048/1353] Projects: cleanup, concise description, stars --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index efb90011e2..72be65c4fc 100644 --- a/README.md +++ b/README.md @@ -152,28 +152,28 @@ Contributions are welcome. Please read the [contributing guidelines](./.github/C ## Related Projects -Made something cool? Feel free to open a PR to add a new row to this table! - -| Project | Description | Last commit | -|---------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [Sublime Text plugin](https://sublime.wbond.net/packages/DevDocs) | Sublime Text plugin to search DevDocs by selection or by input. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/vitorbritto/sublime-devdocs?logo=github&label)](https://github.com/vitorbritto/sublime-devdocs) | -| [Atom plugin](https://atom.io/packages/devdocs) | Atom plugin adding the `doc` command to search DevDocs. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/masnun/atom-devdocs?logo=github&label)](https://github.com/masnun/atom-devdocs) | -| [gruehle/dev-docs-viewer](https://github.com/gruehle/dev-docs-viewer) | Brackets extension for searching and viewing DevDocs content. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/gruehle/dev-docs-viewer?logo=github&label)](https://github.com/gruehle/dev-docs-viewer) | -| [naquad/devdocs-shell](https://github.com/naquad/devdocs-shell) | GTK shell with Vim integration. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/naquad/devdocs-shell?logo=github&label)](https://github.com/naquad/devdocs-shell) | -| [skeeto/devdocs-lookup](https://github.com/skeeto/devdocs-lookup) | Quick Emacs API lookup on DevDocs. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/skeeto/devdocs-lookup?logo=github&label)](https://github.com/skeeto/devdocs-lookup) | -| [yannickglt/alfred-devdocs](https://github.com/yannickglt/alfred-devdocs) | Alfred workflow for DevDocs. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/yannickglt/alfred-devdocs?logo=github&label)](https://github.com/yannickglt/alfred-devdocs) | -| [waiting-for-dev/vim-www](https://github.com/waiting-for-dev/vim-www) | Vim search plugin with DevDocs in its defaults. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/waiting-for-dev/vim-www?logo=github&label)](https://github.com/waiting-for-dev/vim-www) | -| [vscode-devdocs for VS Code](https://marketplace.visualstudio.com/items?itemName=akfish.vscode-devdocs) | VS Code plugin to open and search DevDocs inside VS Code. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/akfish/vscode-devdocs?logo=github&label)](https://github.com/akfish/vscode-devdocs) | -| [devdocs for VS Code](https://marketplace.visualstudio.com/items?itemName=deibit.devdocs) | VS Code plugin to open the browser to search selected text on DevDocs. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/deibit/vscode-devdocs?logo=github&label)](https://github.com/deibit/vscode-devdocs) | -| [egoist/devdocs-desktop](https://github.com/egoist/devdocs-desktop) | Cross-platform desktop application for DevDocs. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/egoist/devdocs-desktop?logo=github&label)](https://github.com/egoist/devdocs-desktop) | -| [qwfy/doc-browser](https://github.com/qwfy/doc-browser) | Native Linux app that supports DevDocs docsets. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/qwfy/doc-browser?logo=github&label)](https://github.com/qwfy/doc-browser) | -| [hardpixel/devdocs-desktop](https://github.com/hardpixel/devdocs-desktop) | GTK3 application for DevDocs with search integrated in the headerbar. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/hardpixel/devdocs-desktop?logo=github&label)](https://github.com/hardpixel/devdocs-desktop) | -| [dteoh/devdocs-macos](https://github.com/dteoh/devdocs-macos) | Native macOS application for DevDocs. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/dteoh/devdocs-macos?logo=github&label)](https://github.com/dteoh/devdocs-macos) | -| [Merith-TK/devdocs_webapp_kotlin](https://github.com/Merith-TK/devdocs_webapp_kotlin) | Android application which shows DevDocs in a webview. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/Merith-TK/devdocs_webapp_kotlin?logo=github&label)](https://github.com/Merith-TK/devdocs_webapp_kotlin) | -| [astoff/devdocs.el](https://github.com/astoff/devdocs.el) | Emacs viewer for DevDocs | [![Latest GitHub commit](https://img.shields.io/github/last-commit/astoff/devdocs.el?logo=github&label)](https://github.com/astoff/devdocs.el) | -| [DevDocs Tab for VS Code](https://github.com/mohamed3nan/DevDocs-Tab) | VS Code extension to search displaying DevDocs.io in a tab. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/mohamed3nan/DevDocs-Tab?logo=github&label)](https://github.com/mohamed3nan/DevDocs-Tab) | -| [quickDocs](https://github.com/mdh34/quickDocs) | DevDocs viewer written in Vala/Python. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/mdh34/quickDocs?logo=github&label)](https://github.com/mdh34/quickDocs) | -| [romainl/vim-devdocs](https://github.com/romainl/vim-devdocs) | Look up keyword on DevDocs from Vim. | [![Latest GitHub commit](https://img.shields.io/github/last-commit/romainl/vim-devdocs?logo=github&label)](https://github.com/romainl/vim-devdocs) | +Made something cool? Feel free to open a PR to add a new row to this table! You might want to discover new projects via https://github.com/topics/devdocs. + + + +| Project | Description | Last commit | Stars | +| ------------------------------------------------------------------------------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | +| [yannickglt/alfred-devdocs](https://github.com/yannickglt/alfred-devdocs) | Alfred workflow | ![Latest GitHub commit](https://img.shields.io/github/last-commit/yannickglt/alfred-devdocs?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/yannickglt/alfred-devdocs?logo=github&label) | +| [Merith-TK/devdocs_webapp_kotlin](https://github.com/Merith-TK/devdocs_webapp_kotlin) | Android application | ![Latest GitHub commit](https://img.shields.io/github/last-commit/Merith-TK/devdocs_webapp_kotlin?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/Merith-TK/devdocs_webapp_kotlin?logo=github&label) | +| [gruehle/dev-docs-viewer](https://github.com/gruehle/dev-docs-viewer) | Brackets extension | ![Latest GitHub commit](https://img.shields.io/github/last-commit/gruehle/dev-docs-viewer?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/gruehle/dev-docs-viewer?logo=github&label) | +| [egoist/devdocs-desktop](https://github.com/egoist/devdocs-desktop) | Electron application | ![Latest GitHub commit](https://img.shields.io/github/last-commit/egoist/devdocs-desktop?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/egoist/devdocs-desktop?logo=github&label) | +| [skeeto/devdocs-lookup](https://github.com/skeeto/devdocs-lookup) | Emacs function | ![Latest GitHub commit](https://img.shields.io/github/last-commit/skeeto/devdocs-lookup?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/skeeto/devdocs-lookup?logo=github&label) | +| [astoff/devdocs.el](https://github.com/astoff/devdocs.el) | Emacs viewer | ![Latest GitHub commit](https://img.shields.io/github/last-commit/astoff/devdocs.el?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/astoff/devdocs.el?logo=github&label) | +| [naquad/devdocs-shell](https://github.com/naquad/devdocs-shell) | GTK shell with Vim integration | ![Latest GitHub commit](https://img.shields.io/github/last-commit/naquad/devdocs-shell?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/naquad/devdocs-shell?logo=github&label) | +| [hardpixel/devdocs-desktop](https://github.com/hardpixel/devdocs-desktop) | GTK application | ![Latest GitHub commit](https://img.shields.io/github/last-commit/hardpixel/devdocs-desktop?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/hardpixel/devdocs-desktop?logo=github&label) | +| [qwfy/doc-browser](https://github.com/qwfy/doc-browser) | Linux application | ![Latest GitHub commit](https://img.shields.io/github/last-commit/qwfy/doc-browser?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/qwfy/doc-browser?logo=github&label) | +| [dteoh/devdocs-macos](https://github.com/dteoh/devdocs-macos) | macOS application | ![Latest GitHub commit](https://img.shields.io/github/last-commit/dteoh/devdocs-macos?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/dteoh/devdocs-macos?logo=github&label) | +| [Sublime Text plugin](https://sublime.wbond.net/packages/DevDocs) | Sublime Text plugin | ![Latest GitHub commit](https://img.shields.io/github/last-commit/vitorbritto/sublime-devdocs?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/vitorbritto/sublime-devdocs?logo=github&label) | +| [mohamed3nan/DevDocs-Tab](https://github.com/mohamed3nan/DevDocs-Tab) | VS Code extension (view as tab) | ![Latest GitHub commit](https://img.shields.io/github/last-commit/mohamed3nan/DevDocs-Tab?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/mohamed3nan/DevDocs-Tab?logo=github&label) | +| [deibit/vscode-devdocs](https://marketplace.visualstudio.com/items?itemName=deibit.devdocs) | VS Code extension (open the browser) | ![Latest GitHub commit](https://img.shields.io/github/last-commit/deibit/vscode-devdocs?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/deibit/vscode-devdocs?logo=github&label) | +| [mdh34/quickDocs](https://github.com/mdh34/quickDocs) | Vala/Python based viewer | ![Latest GitHub commit](https://img.shields.io/github/last-commit/mdh34/quickDocs?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/mdh34/quickDocs?logo=github&label) | +| [romainl/vim-devdocs](https://github.com/romainl/vim-devdocs) | Vim plugin | ![Latest GitHub commit](https://img.shields.io/github/last-commit/romainl/vim-devdocs?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/romainl/vim-devdocs?logo=github&label) | +| [waiting-for-dev/vim-www](https://github.com/waiting-for-dev/vim-www) | Vim plugin | ![Latest GitHub commit](https://img.shields.io/github/last-commit/waiting-for-dev/vim-www?logo=github&label) | ![GitHub stars](https://img.shields.io/github/stars/waiting-for-dev/vim-www?logo=github&label) | ## Copyright / License From e1d472c906c8156e1c294766a5a7afe63d0bf4eb Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Mon, 26 Dec 2022 17:52:27 +0100 Subject: [PATCH 0049/1353] It's almost 2023 --- COPYRIGHT | 2 +- README.md | 2 +- assets/javascripts/lib/license.coffee | 2 +- assets/javascripts/templates/pages/about_tmpl.coffee | 2 +- assets/stylesheets/application.css.scss | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/COPYRIGHT b/COPYRIGHT index 8b56007921..9a294f24f1 100644 --- a/COPYRIGHT +++ b/COPYRIGHT @@ -1,4 +1,4 @@ -Copyright 2013-2021 Thibaut Courouble and other contributors +Copyright 2013-2023 Thibaut Courouble and other contributors This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this diff --git a/README.md b/README.md index 72be65c4fc..5ccd14919c 100644 --- a/README.md +++ b/README.md @@ -177,7 +177,7 @@ Made something cool? Feel free to open a PR to add a new row to this table! You ## Copyright / License -Copyright 2013–2021 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors) +Copyright 2013–2023 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors) This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](./COPYRIGHT) and [LICENSE](./LICENSE) files. diff --git a/assets/javascripts/lib/license.coffee b/assets/javascripts/lib/license.coffee index 56725552fc..c397b93b19 100644 --- a/assets/javascripts/lib/license.coffee +++ b/assets/javascripts/lib/license.coffee @@ -1,5 +1,5 @@ ### - * Copyright 2013-2021 Thibaut Courouble and other contributors + * Copyright 2013-2023 Thibaut Courouble and other contributors * * This source code is licensed under the terms of the Mozilla * Public License, v. 2.0, a copy of which may be obtained at: diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 74b036ebae..682ee5b779 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -22,7 +22,7 @@ app.templates.aboutPage = -> """

- Copyright 2013–2021 Thibaut Courouble and other contributors
+ Copyright 2013–2023 Thibaut Courouble and other contributors
This software is licensed under the terms of the Mozilla Public License v2.0.
You may obtain a copy of the source code at github.com/freeCodeCamp/devdocs.
For more information, see the COPYRIGHT diff --git a/assets/stylesheets/application.css.scss b/assets/stylesheets/application.css.scss index e7a725e797..a191f2896b 100644 --- a/assets/stylesheets/application.css.scss +++ b/assets/stylesheets/application.css.scss @@ -3,7 +3,7 @@ //= depend_on sprites/docs.json /*! - * Copyright 2013-2021 Thibaut Courouble and other contributors + * Copyright 2013-2023 Thibaut Courouble and other contributors * * This source code is licensed under the terms of the Mozilla * Public License, v. 2.0, a copy of which may be obtained at: From eac7f96cdbdd334b1ae2d113237cf126060b5d38 Mon Sep 17 00:00:00 2001 From: Simon Legner Date: Mon, 26 Dec 2022 18:39:36 +0100 Subject: [PATCH 0050/1353] /about: Obtain credits from docs metadata --- .../templates/pages/about_tmpl.coffee | 953 +----------------- assets/stylesheets/components/_content.scss | 2 +- lib/docs/core/doc.rb | 8 + lib/docs/core/manifest.rb | 2 +- test/lib/docs/core/manifest_test.rb | 4 +- 5 files changed, 27 insertions(+), 942 deletions(-) diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 682ee5b779..681155cdf1 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -1,4 +1,9 @@ -app.templates.aboutPage = -> """ +app.templates.aboutPage = -> + all_docs = app.docs.all().concat(app.disabledDocs.all()...) + # de-duplicate docs by doc.name + docs = [] + docs.push doc for doc in all_docs when not (docs.find (d) -> d.name == doc.name) + """