Skip to content

Fix Qt entry typing #2587

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix Qt entry typing #2587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions lib/docs/filters/qt/clean_html.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,19 @@ module Docs
class Qt
class CleanHtmlFilter < Filter
def call
# Remove unneeded elements
css('.copy-notice, .navigationbar, .headerNavi, .footerNavi, .sidebar, .toc, #ec_toggle', '.landingicons img', 'br').remove
# Narrow down container further. Breadcrumb is safe to remove.
@doc = at_css('article .mainContent .context') unless root_page?

css('h1').remove_attribute('class')

# QML property/method header
css('.qmlproto').each do |node|
id = node.at_css('tr')['id']
id = node.at_css('a')['name'] if id.blank?
id = node.at_css('span.name').content
node.inner_html = node.at_css('td').inner_html
node.name = 'h3'
node['id'] = id
end

css('.main-rounded', '.content', '.line', '.context', '.descr', '.types', '.func', '.table', 'div:not([class])', '.landing', '.col-1', '.heading', '.qmlitem', '.qmldoc', 'div.pre').each do |node|
node.before(node.children).remove
end

css('pre').each do |node|
node.content = node.content
node['data-language'] = 'cpp' if node['class'].include?('cpp')
Expand Down
28 changes: 5 additions & 23 deletions lib/docs/filters/qt/entries.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,8 @@ def get_name
end

def get_type
breadcrumb = css('#main_title_bar + ul li')
category = if breadcrumb.length < 3
then 'Qt'.dup
else breadcrumb.at(1).content
end

if category == 'Qt'
return 'Qt Platforms' if name.include?(' for ') || name == 'Qt Platform Abstraction'
return 'Qt Quick' if name == 'Qt Quick Test' || name == 'Qt Quick Test Reference Documentation'

alwaysInQt = ['Qt Configure Options', 'Qt Image Formats']
category = name if name.start_with?('Qt ') && !alwaysInQt.include?(name)
end

qtPlatformsTypes = ['Qt Platform Headers', 'Qt Android Extras', 'Qt Mac Extras', 'Qt Windows Extras', 'Qt X11 Extras']
return 'Qt Platforms' if qtPlatformsTypes.include?(category)

category.remove!(' Manual')
category
breadcrumb = css('ul.c-breadcrump li') # Yes, really: breadcrump.
breadcrumb[1].content
end

def include_default_entry?
Expand Down Expand Up @@ -107,11 +90,9 @@ def additional_entries
end

# QML properties/functions
qmlTypeName = at_css('h1.title').content.remove(' QML Type', '')
css('.qmlproto').each do |node|
title = node.content.strip
id = node.at_css('tr')['id']
id = node.at_css('a')['name'] if id.blank?
id = node.at_css('span.name').content

# Remove options
title.remove!(%r{^\[.*\] })
Expand All @@ -128,7 +109,8 @@ def additional_entries
# Remove return type
title.remove!(%r{.* })

title = "#{qmlTypeName}.#{title.strip}"
title = title.strip

unless titles.include?(title) # Remove duplicates (function overloading)
entries << [title, id]
titles.push(title)
Expand Down
13 changes: 10 additions & 3 deletions lib/docs/scrapers/qt.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ class Qt < UrlScraper

html_filters.push 'qt/entries', 'qt/clean_html'

options[:container] = 'article, .main'
options[:max_image_size] = 156_000
options[:container] = '.b-sidebar__content'
options[:max_image_size] = 256_000
options[:skip_patterns] = [
# License, copyright attributions
/3rdparty/,
Expand Down Expand Up @@ -56,6 +56,8 @@ class Qt < UrlScraper
"compatmap.html",

# Indexes
"qdoc-index.html",
"qmake-manual.html",
"classes.html",
"qtmodules.html",
"modules-qml.html",
Expand Down Expand Up @@ -103,7 +105,12 @@ class Qt < UrlScraper
Licensed under the GNU Free Documentation License, Version 1.3.
HTML

version do
version '6.9' do
self.release = '6.9'
self.base_url = "https://doc.qt.io/qt-#{self.release}/"
end

version '6.8' do
self.release = '6.8'
self.base_url = "https://doc.qt.io/qt-#{self.release}/"
end
Expand Down