salt_stack: finish scraper and filters

Jasper van Merle committed 7 years ago

Commit f3d5a6e1 parent 96a72024 files · +51 −11Browse files

Unified · Split

4 files

     'MIT',
     'https://raw.githubusercontent.com/rust-lang/rust/master/LICENSE-MIT'
   ], [
+    'Salt Stack',
+    '2019 SaltStack',
+    'Apache',
+    'https://raw.githubusercontent.com/saltstack/salt/develop/LICENSE'
+  ],
+  [
     'Sass',
     '2006-2016 Hampton Catlin, Nathan Weizenbaum, and Chris Eppstein',
     'MIT',

@@ -4,6 +4,17 @@ module Docs · 3 unmodified lines
4	def call	4	def call
5	css('.headerlink').remove	5	css('.headerlink').remove
6		6
		7	css('div[class^="highlight-"]').each do \|node\|
		8	node.name = 'pre'
		9	node['data-language'] = node['class'].scan(/highlight-([a-z]+)/i)[0][0]
		10	node.content = node.content.strip
		11	end
		12
		13	css('.function > dt').each do \|node\|
		14	node.name = 'h3'
		15	node.content = node.content
		16	end
		17
7	doc	18	doc
8	end	19	end
9	end	20	end

       end
       def get_type
-        slug.split('/', 2).first
+        slug.split('/', 3)[1]
       end
       def include_default_entry?
         slug.split('/').last.start_with? 'salt'
       end
+      def additional_entries
+        entries = []
+        css('.function > h3').each do |node|
+          name = node.content.remove('salt.').split('(')[0] + '()'
+          entries << [name, node['id']]
+        end
+        entries
+      end
     end
   end
 end

 module Docs
-  class SaltStack < UrlScraper
+  # The official documentation website is heavily rate-limited
-    self.type = 'salt_stack'
+  #
-    self.release = '2018.3.2'
+  # The documentation can be generated like this (replace 2019.2 with the correct tag):
-    self.base_url = 'https://docs.saltstack.com/en/latest/ref/'
+  # $ git clone https://github.com/saltstack/salt.git --branch 2019.2 --depth 1
+  # $ cd salt/doc
+  # $ pip install sphinx
+  # $ make html
+  #
+  # The generated html can be found in salt/doc/_build/html
+  class SaltStack < FileScraper
+    self.type = 'simple'
+    self.slug = 'salt_stack'
+    self.release = '2019.2.0'
+    self.base_url = 'https://docs.saltstack.com/en/latest/'
+    self.root_path = 'ref/index.html'
     self.links = {
       home: 'https://www.saltstack.com/',
       code: 'https://github.com/saltstack/salt'
     html_filters.push 'salt_stack/clean_html', 'salt_stack/entries'
-    options[:only_patterns] = [
+    options[:only_patterns] = [/all\//]
-      %r{^[^/]+/all/}
+    options[:container] = '.body-content > .section'
-    ]
-    options[:container] = '.body-content'
     options[:attribution] = <<-HTML
-      &copy; 2018 SaltStack.<br>
+      &copy; 2019 SaltStack.<br>
       Licensed under the Apache License, Version 2.0.
     HTML
+    def get_latest_version(opts)
+      get_latest_github_release('saltstack', 'salt', opts)
+    end
   end
 end

Keyboard shortcuts