diff --git a/assets/images/docs-2.png b/assets/images/docs-2.png index 53352548..a51bd345 100644 Binary files a/assets/images/docs-2.png and b/assets/images/docs-2.png differ diff --git a/assets/images/docs-2@2x.png b/assets/images/docs-2@2x.png index 977564c5..6c9d7be6 100644 Binary files a/assets/images/docs-2@2x.png and b/assets/images/docs-2@2x.png differ diff --git a/assets/javascripts/news.json b/assets/javascripts/news.json index 4e428963..deb27dbd 100644 --- a/assets/javascripts/news.json +++ b/assets/javascripts/news.json @@ -1,7 +1,7 @@ [ [ "2017-06-04", - "New documentations: Electron, Pug" + "New documentations: Electron, Pug, and Falcon" ], [ "2017-05-14", "New documentations: Jest, Jasmine and Liquid" diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 14f229c3..74828e5e 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -243,6 +243,11 @@ credits = [ '2016 StrongLoop, IBM, and other expressjs.com contributors.', 'CC BY-SA', 'https://raw.githubusercontent.com/expressjs/expressjs.com/gh-pages/LICENSE.md' + ], [ + 'Falcon', + '2012-2016 by Rackspace Hosting, Inc. and other contributors', + 'Apache', + 'https://raw.githubusercontent.com/falconry/falcon/master/LICENSE' ], [ 'Fish', '2005-2009 Axel Liljencrantz', diff --git a/assets/stylesheets/global/_icons.scss b/assets/stylesheets/global/_icons.scss index 1240941a..3d2db9fd 100644 --- a/assets/stylesheets/global/_icons.scss +++ b/assets/stylesheets/global/_icons.scss @@ -174,3 +174,4 @@ ._icon-jasmine:before { background-position: 0 -2rem; @extend %doc-icon-2; } ._icon-pug:before { background-position: -1rem -2rem; @extend %doc-icon-2; } ._icon-electron:before { background-position: -2rem -2rem; @extend %doc-icon-2; } +._icon-falcon:before { background-position: -3rem -2rem; @extend %doc-icon-2; } diff --git a/lib/docs/filters/falcon/entries.rb b/lib/docs/filters/falcon/entries.rb index dc737d87..a4c2f85f 100644 --- a/lib/docs/filters/falcon/entries.rb +++ b/lib/docs/filters/falcon/entries.rb @@ -9,14 +9,10 @@ module Docs def get_type case slug.split('/').first - when 'community' - 'Community Guide' when 'user' - 'User Guide' + 'Guide' when 'api' - 'Classes and Functions' - else - 'Other' + 'API' end end @@ -24,23 +20,33 @@ module Docs entries = [] css('.class').each do |node| + namespace = node.at_css('.descclassname').content.strip.remove(/\.\z/) class_name = node.at_css('dt > .descname').content class_id = node.at_css('dt[id]')['id'] - entries << [class_name, class_id] + entries << ["#{namespace}.#{class_name}", class_id, namespace] + + node.css('.attribute').each do |n| + next unless n.at_css('dt[id]') + name = n.at_css('.descname').content + name = "#{namespace}.#{class_name}.#{name}" + id = n.at_css('dt[id]')['id'] + entries << [name, id, namespace] + end node.css('.method').each do |n| next unless n.at_css('dt[id]') name = n.at_css('.descname').content - name = "#{class_name}.#{name}()" + name = "#{namespace}.#{class_name}.#{name}()" id = n.at_css('dt[id]')['id'] - entries << [name, id] + entries << [name, id, namespace] end end css('.function').each do |node| - name = "#{node.at_css('.descname').content}()" + namespace = node.at_css('.descclassname').content.strip.remove(/\.\z/) + name = "#{namespace}.#{node.at_css('.descname').content}()" id = node.at_css('dt[id]')['id'] - entries << [name, id] + entries << [name, id, namespace] end entries diff --git a/lib/docs/scrapers/falcon.rb b/lib/docs/scrapers/falcon.rb index 593e62b8..2073053b 100644 --- a/lib/docs/scrapers/falcon.rb +++ b/lib/docs/scrapers/falcon.rb @@ -11,17 +11,17 @@ module Docs options[:container] = '.body' - options[:skip_patterns] = [/\Achanges/, /\A_modules/] + options[:skip] = %w(user/index.html api/index.html) + options[:skip_patterns] = [/\Achanges/, /\A_modules/, /\Acommunity/] options[:attribution] = <<-HTML - © 2016 Falcon Contributors
- Licensed under the Apache 2 License. + © 2012–2016 by Rackspace Hosting, Inc. and other contributors
+ Licensed under the Apache License, Version 2.0. HTML - version '1.2.0' do + version '1.2' do self.release = '1.2.0' - self.base_url = "https://falcon.readthedocs.io/en/#{self.version}/" + self.base_url = "https://falcon.readthedocs.io/en/#{self.release}/" end - end end diff --git a/public/icons/docs/falcon/16.png b/public/icons/docs/falcon/16.png new file mode 100644 index 00000000..bfb2deed Binary files /dev/null and b/public/icons/docs/falcon/16.png differ diff --git a/public/icons/docs/falcon/16@2x.png b/public/icons/docs/falcon/16@2x.png new file mode 100644 index 00000000..7061ed43 Binary files /dev/null and b/public/icons/docs/falcon/16@2x.png differ diff --git a/public/icons/docs/falcon/SOURCE b/public/icons/docs/falcon/SOURCE index ec12aba9..53495509 100644 --- a/public/icons/docs/falcon/SOURCE +++ b/public/icons/docs/falcon/SOURCE @@ -1 +1 @@ -https://github.com/falconry/falcon/blob/master/docs/_static/img/logo.jpg +https://github.com/falconry/falconry.github.io