Merge pull request #1003 from emilekm/master

Add Django REST Framework documentantion

Co-authored-by: Jasper van Merle <jaspervmerle@gmail.com>

assets/javascripts/templates/pages/about_tmpl.coffee

@@ -231,6 +231,11 @@ credits = [
     'Django Software Foundation and individual contributors',
     'BSD',
     'https://raw.githubusercontent.com/django/django/master/LICENSE'
+  ], [
+    'Django REST Framework',
+    '2011-present Encode OSS Ltd.',
+    'BSD',
+    'https://raw.githubusercontent.com/encode/django-rest-framework/master/LICENSE.md'
   ], [
     'Docker',
     '2019 Docker, Inc.<br>Docker and the Docker logo are trademarks of Docker, Inc.',

assets/stylesheets/application.css.scss

@@ -72,6 +72,7 @@
         'pages/lua',
         'pages/mdn',
         'pages/meteor',
+        'pages/mkdocs',
         'pages/modernizr',
         'pages/moment',
         'pages/nginx',

assets/stylesheets/pages/_mkdocs.scss

@@ -0,0 +1,11 @@
+._mkdocs {
+  h2 { @extend %block-heading; }
+  h3 { @extend %block-label, %label-blue; }
+  h4 { @extend %block-label; }
+
+  blockquote { @extend %note; }
+
+  strong { font-weight: var(--bolderFontWeight); }
+
+  p > code, li > code { @extend %label; }
+}

lib/docs/filters/django_rest_framework/clean_html.rb

@@ -0,0 +1,30 @@
+module Docs
+  class DjangoRestFramework
+    class CleanHtmlFilter < Docs::Filter
+      def call
+        css('hr').remove
+        css('.badges').remove
+
+        css('pre').attr('data-language', 'python')
+
+        css('h1').remove_attribute('style')
+        css('.promo a').remove_attribute('style')
+
+        # Translate source files links to DevDocs links
+        links = Nokogiri::XML::Node.new('p', doc)
+        links['class'] = '_links'
+
+        css('a.github').each do |node|
+          span = node.at_css('span')
+          node.content = span.content
+          node['class'] = '_links-link'
+          links.add_child(node)
+        end
+
+        doc.add_child(links)
+
+        doc
+      end
+    end
+  end
+end

lib/docs/filters/django_rest_framework/entries.rb

@@ -0,0 +1,59 @@
+module Docs
+  class DjangoRestFramework
+    class EntriesFilter < Docs::EntriesFilter
+      def get_name
+        name = css('h1').first.content
+        name.slice! 'Tutorial '
+        name = '0: ' + name if name.include? 'Quickstart'
+        name
+      end
+
+      def get_type
+        case subpath
+        when /\Atutorial/
+          'Tutorial'
+        when /\Aapi-guide/
+          'API Guide'
+        end
+      end
+
+      def additional_entries
+        return [] if type == nil || type == 'Tutorial'
+
+        # Framework classes are provided in two different ways:
+        # - as H2's after H1 category titled:
+        accepted_headers = ['API Reference', 'API Guide']
+        # - as headers (1 or 2) with these endings:
+        endings = ['Validator', 'Field', 'View', 'Mixin', 'Default', 'Serializer']
+
+        # To avoid writing down all the endings
+        # and to ensure all entries in API categories are matched
+        # two different ways of finding them are used
+
+        entries = []
+
+        local_type = 'Ref: ' + name
+        in_category = false
+
+        css('h1, h2').each do |node|
+          # Third party category contains entries that could be matched (and shouldn't be)
+          break if node.content === 'Third party packages'
+
+          if in_category
+            if node.name === 'h1'
+              in_category = false
+              next
+            end
+            entries << [node.content, node['id'], local_type]
+          elsif accepted_headers.include? node.content
+            in_category = true
+          elsif endings.any? { |word| node.content.ends_with?(word) }
+            entries << [node.content, node['id'], local_type]
+          end
+        end
+
+        entries
+      end
+    end
+  end
+end

lib/docs/filters/mkdocs/clean_html.rb

@@ -0,0 +1,17 @@
+module Docs
+  class Mkdocs
+    class CleanHtmlFilter < Docs::Filter
+      def call
+        css('.toclink').each do |node|
+          node.parent.content = node.content
+        end
+
+        css('pre').each do |node|
+          node.content = node.at_css('code').content
+        end
+
+        at_css('#main-content')
+      end
+    end
+  end
+end

lib/docs/scrapers/mkdocs/django_rest_framework.rb

@@ -0,0 +1,29 @@
+module Docs
+  class DjangoRestFramework < Mkdocs
+    self.name = 'Django REST Framework'
+    self.release = '3.9.3'
+    self.slug = 'django_rest_framework'
+    self.base_url = 'https://www.django-rest-framework.org/'
+    self.root_path = 'index.html'
+    self.links = {
+      home: 'https://www.django-rest-framework.org/',
+      code: 'https://github.com/encode/django-rest-framework'
+    }
+
+    html_filters.push 'django_rest_framework/clean_html', 'django_rest_framework/entries'
+
+    options[:skip_patterns] = [
+      /\Atopics\//,
+      /\Acommunity\//,
+    ]
+
+    options[:attribution] = <<-HTML
+      Copyright &copy; 2011&ndash;present Encode OSS Ltd.<br>
+      Licensed under the BSD License.
+    HTML
+
+    def get_latest_version(opts)
+      get_latest_github_release('encode', 'django-rest-framework', opts)
+    end
+  end
+end

lib/docs/scrapers/mkdocs/mkdocs.rb

@@ -0,0 +1,19 @@
+module Docs
+  class Mkdocs < UrlScraper
+    self.abstract = true
+    self.type = 'mkdocs'
+
+    html_filters.push 'mkdocs/clean_html'
+
+    private
+
+    def handle_response(response)
+      # Some scrapped urls don't have ending slash
+      # which leads to page duplication
+      if !response.url.path.ends_with?('/') && !response.url.path.ends_with?('index.html')
+        response.url.path << '/'
+      end
+      super
+    end
+  end
+end

public/icons/docs/django_rest_framework/SOURCE

@@ -0,0 +1 @@
+https://github.com/encode/django-rest-framework/blob/master/docs_theme/img/favicon.ico