Update Fish scraper

Phil Scherer committed 5 years ago

Commit be80d181 parent 674dc1e8 files · +72 −3Browse files

Unified · Split

8 files

lib/docs/filters/fish/clean_html_custom.rb +1 −1
lib/docs/filters/fish/clean_html_sphinx.rb +10 −0
lib/docs/filters/fish/entries_custom.rb +1 −1
lib/docs/filters/fish/entries_sphinx.rb +39 −0
lib/docs/scrapers/fish.rb +22 −3
public/icons/docs/fish/16.png +0 −0
public/icons/docs/fish/16@2x.png +0 −0
public/icons/docs/fish/SOURCE +1 −0

lib/docs/filters/fish/clean_html_custom.rbrenamed from lib/docs/filters/fish/clean_html.rb+1−1

@@ -1,6 +1,6 @@
1	1	module Docs
2	2	class Fish
3		− class CleanHtmlFilter < Filter
	3	+ class CleanHtmlCustomFilter < Filter
4	4	def call
5	5	@doc = at_css('.fish_right_bar')
6	6

lib/docs/filters/fish/clean_html_sphinx.rb+10−0

@@ -0,0 +1,10 @@
	1	+module Docs
	2	+ class Fish
	3	+ class CleanHtmlSphinxFilter < Filter
	4	+ def call
	5	+ @doc = at_css('.body')
	6	+ doc
	7	+ end
	8	+ end
	9	+ end
	10	+end

lib/docs/filters/fish/entries_custom.rbrenamed from lib/docs/filters/fish/entries.rb+1−1

@@ -1,6 +1,6 @@
1	1	module Docs
2	2	class Fish
3		− class EntriesFilter < Docs::EntriesFilter
	3	+ class EntriesCustomFilter < Docs::EntriesFilter
4	4	def get_name
5	5	if slug == 'faq'
6	6	'FAQ'

lib/docs/filters/fish/entries_sphinx.rb+39−0

@@ -0,0 +1,39 @@
	1	+module Docs
	2	+ class Fish
	3	+ class EntriesSphinxFilter < Docs::EntriesFilter
	4	+ def get_name
	5	+ if slug == 'faq'
	6	+ 'FAQ'
	7	+ elsif slug.starts_with?('cmds/')
	8	+ slug.split('/').last
	9	+ else
	10	+ slug.capitalize
	11	+ end
	12	+ end
	13	+
	14	+ def get_type
	15	+ if root_page? \|\| slug == 'faq'
	16	+ 'Manual'
	17	+ elsif slug.starts_with?('cmds')
	18	+ 'Commands'
	19	+ elsif slug == 'tutorial'
	20	+ 'Tutorial'
	21	+ else
	22	+ nil # Remaining pages are indexes we don't need
	23	+ end
	24	+ end
	25	+
	26	+ def additional_entries
	27	+ if root_page? \|\| slug == 'tutorial'
	28	+ css('h2').map.with_index do \|node, i\|
	29	+ name = node.content.split(' - ').first.strip
	30	+ name.prepend "#{i + 1}. "
	31	+ [name, node['id'], get_type]
	32	+ end
	33	+ else
	34	+ []
	35	+ end
	36	+ end
	37	+ end
	38	+ end
	39	+end

lib/docs/scrapers/fish.rb+22−3

@@ -8,49 +8,68 @@ module Docs · 7 unmodified lines
8	8	code: 'https://github.com/fish-shell/fish-shell'
9	9	}
10	10
11		− html_filters.push 'fish/clean_html', 'fish/entries'
12		−
13	11	options[:skip] = %w(design.html license.html)
14	12
15	13	# https://fishshell.com/docs/current/license.html
16	14	options[:attribution] = <<-HTML
17		− © 2005–2009 Axel Liljencrantz<br>
	15	+ © 2019 fish-shell developers<br>
18	16	Licensed under the GNU General Public License, version 2.
19	17	HTML
20	18
	19	+ version '3.1' do
	20	+ self.release = '3.1.2'
	21	+ self.base_url = "https://fishshell.com/docs/#{version}/"
	22	+
	23	+ html_filters.push 'sphinx/clean_html', 'fish/clean_html_sphinx', 'fish/entries_sphinx'
	24	+ end
	25	+
21	26	version '3.0' do
22	27	self.release = '3.0.1'
23	28	self.base_url = "https://fishshell.com/docs/#{version}/"
	29	+
	30	+ html_filters.push 'fish/clean_html_custom', 'fish/entries_custom'
24	31	end
25	32
26	33	version '2.7' do
27	34	self.release = '2.7.1'
28	35	self.base_url = "https://fishshell.com/docs/#{version}/"
	36	+
	37	+ html_filters.push 'fish/clean_html_custom', 'fish/entries_custom'
29	38	end
30	39
31	40	version '2.6' do
32	41	self.release = '2.6.0'
33	42	self.base_url = "https://fishshell.com/docs/#{version}/"
	43	+
	44	+ html_filters.push 'fish/clean_html_custom', 'fish/entries_custom'
34	45	end
35	46
36	47	version '2.5' do
37	48	self.release = '2.5.0'
38	49	self.base_url = "https://fishshell.com/docs/#{version}/"
	50	+
	51	+ html_filters.push 'fish/clean_html_custom', 'fish/entries_custom'
39	52	end
40	53
41	54	version '2.4' do
42	55	self.release = '2.4.0'
43	56	self.base_url = "https://fishshell.com/docs/#{version}/"
	57	+
	58	+ html_filters.push 'fish/clean_html_custom', 'fish/entries_custom'
44	59	end
45	60
46	61	version '2.3' do
47	62	self.release = '2.3.1'
48	63	self.base_url = "https://fishshell.com/docs/#{version}/"
	64	+
	65	+ html_filters.push 'fish/clean_html_custom', 'fish/entries_custom'
49	66	end
50	67
51	68	version '2.2' do
52	69	self.release = '2.2.0'
53	70	self.base_url = "https://fishshell.com/docs/#{version}/"
	71	+
	72	+ html_filters.push 'fish/clean_html_custom', 'fish/entries_custom'
54	73	end
55	74
56	75	def get_latest_version(opts)

public/icons/docs/fish/16.png+0−0

Binary file not shown.

public/icons/docs/fish/16@2x.png+0−0

Binary file not shown.

public/icons/docs/fish/SOURCE+1−0

@@ -0,0 +1 @@
	1	+https://fishshell.com/favicon.ico