Update and improve Go documentation (1.7.4)

Closes #538. Closes #540. Closes #541.

Thibaut Courouble committed 9 years ago

Commit cd8188b1 parent 06cf1184 files · +38 −12Browse files

Unified · Split

4 files

@@ -2,4 +2,9 @@ · 1 unmodified line
2	@extend %simple;	2	@extend %simple;
3		3
4	#short-nav, table.dir { margin-left: -1rem; }	4	#short-nav, table.dir { margin-left: -1rem; }
		5
		6	a.source {
		7	float: right;
		8	font-size: .9em;
		9	}
5	}	10	}

           node.before(node.children).remove
         end
+        css('h2 a', 'h3 a').each do |node|
+          if node['href'].include?('/src/')
+            node.after %(<a href="#{node['href']}" class="source">Source</a>)
+            node.before(node.children).remove
+          end
+        end
         # Remove triangle character
         css('h2', '.exampleHeading').each do |node|
-          node.content = node.content.remove("\u25BE")
+          node.inner_html = node.inner_html.remove("\u25BE")
           node.name = 'h4' unless node.name == 'h2'
         end
           node.content = node.content
         end
-        css('td[style]', 'ul[style]').each do |node|
+        css('td[style]', 'ul[style]').remove_attr('style')
-          node.remove_attribute('style')
+        css('.toggleButton[title]').remove_attr('title')
-        end
+        css('.toggleButton').remove_attr('class')
         doc
       end

   class Go
     class EntriesFilter < Docs::EntriesFilter
       def get_name
-        name = at_css('h1').content
+        code = at_css('code')
-        name.remove! 'Package '
+        if code && name = code.content[/import "([\w\/]+)"/, 1]
-        name
+          name
+        else
+          name = at_css('h1').content
+          name.remove! 'Package '
+          name
+        end
       end
       def get_type
-        subpath[/\A[^\/]+/]
+        package = subpath[/\A[^\/]+/]
+        if package.in?(%w(math net))
+          name.split('/')[0..1].join('/')
+        else
+          package
+        end
       end
       def additional_entries
+        return [] if root_page?
+        package = self.name.split('/').last
         css('#manual-nav a').each_with_object [] do |node, entries|
           case node.content
           when /type\ (\w+)/
-            name = "#{$1} (#{self.name})"
+            name = "#{package}.#{$1}"
           when /func\ (?:\(.+\)\ )?(\w+)\(/
-            name = "#{$1}() (#{self.name})"
+            name = "#{$1}()"
             name.prepend "#{$1}." if node['href'] =~ /#(\w+)\.#{$1}/
+            name.prepend "#{package}."
           when 'Constants'
             name = "#{self.name} constants"
           when 'Variables'
       end
       def include_default_entry?
-        !at_css('h1 + table.dir')
+        !at_css('h1 + .pkg-dir')
       end
     end
   end

 module Docs
   class Go < UrlScraper
     self.type = 'go'
-    self.release = '1.7.3'
+    self.release = '1.7.4'
     self.base_url = 'https://golang.org/pkg/'
     self.links = {
       home: 'https://golang.org/',
     options[:trailing_slash] = true
     options[:container] = '#page .container'
+    options[:skip] = %w(runtime/msan/)
     options[:attribution] = <<-HTML
       &copy; Google, Inc.<br>