Unified · Split
| @@ -0,0 +1,103 @@ | ||
| 1 | +module Docs | |
| 2 | + class Wagtail < UrlScraper | |
| 3 | + self.name = 'Wagtail' | |
| 4 | + self.type = 'sphinx' | |
| 5 | + self.root_path = 'index.html' | |
| 6 | + self.links = { | |
| 7 | + home: 'https://wagtail.org/', | |
| 8 | + code: 'https://github.com/wagtail/wagtail' | |
| 9 | + } | |
| 10 | + | |
| 11 | + # adding filters from lib/docs/filters/wagtail | |
| 12 | + html_filters.push 'wagtail/entries', 'sphinx/clean_html', 'wagtail/clean_html' | |
| 13 | + | |
| 14 | + # attributions are seen at the bottom of every page(copyright and license etc. details) | |
| 15 | + options[:attribution] = <<-HTML | |
| 16 | + © 2014-present Torchbox Ltd and individual contributors.<br> | |
| 17 | + All rights are reserved.<br> | |
| 18 | + Licensed under the BSD License. | |
| 19 | + HTML | |
| 20 | + | |
| 21 | + # no one wants to see docs about search or release notes | |
| 22 | + options[:skip] = %w[search.html] | |
| 23 | + options[:skip_patterns] = [ | |
| 24 | + %r{\Areleases/} | |
| 25 | + ] | |
| 26 | + | |
| 27 | + # updating release and base_url for different versions | |
| 28 | + version 'stable' do | |
| 29 | + self.release = 'stable' | |
| 30 | + self.base_url = 'https://docs.wagtail.org/en/stable/' | |
| 31 | + end | |
| 32 | + | |
| 33 | + version 'latest' do | |
| 34 | + self.release = 'latest' | |
| 35 | + self.base_url = 'https://docs.wagtail.org/en/latest/' | |
| 36 | + end | |
| 37 | + | |
| 38 | + version '4.0.4' do | |
| 39 | + self.release = '4.0.4' | |
| 40 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 41 | + end | |
| 42 | + | |
| 43 | + version '4.0' do | |
| 44 | + self.release = '4.0' | |
| 45 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 46 | + end | |
| 47 | + | |
| 48 | + version '3.0.3' do | |
| 49 | + self.release = '3.0.3' | |
| 50 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 51 | + end | |
| 52 | + | |
| 53 | + version '2.16.3' do | |
| 54 | + self.release = '2.16.3' | |
| 55 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 56 | + end | |
| 57 | + | |
| 58 | + version '2.15.6' do | |
| 59 | + self.release = '2.15.6' | |
| 60 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 61 | + end | |
| 62 | + | |
| 63 | + version '2.10.2' do | |
| 64 | + self.release = '2.10.2' | |
| 65 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 66 | + end | |
| 67 | + | |
| 68 | + version '2.5.2' do | |
| 69 | + self.release = '2.5.2' | |
| 70 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 71 | + end | |
| 72 | + | |
| 73 | + version '2.4' do | |
| 74 | + self.release = '2.4' | |
| 75 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 76 | + end | |
| 77 | + | |
| 78 | + version '2.3' do | |
| 79 | + self.release = '2.3' | |
| 80 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 81 | + end | |
| 82 | + | |
| 83 | + version '2.0.2' do | |
| 84 | + self.release = '2.0.2' | |
| 85 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 86 | + end | |
| 87 | + | |
| 88 | + version '1.2' do | |
| 89 | + self.release = '1.2' | |
| 90 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 91 | + end | |
| 92 | + | |
| 93 | + version '1.1' do | |
| 94 | + self.release = '1.1' | |
| 95 | + self.base_url = "https://docs.wagtail.org/en/v#{version}/" | |
| 96 | + end | |
| 97 | + | |
| 98 | + # this method will fetch the latest version of wagtail | |
| 99 | + def get_latest_version(opts) | |
| 100 | + get_latest_github_release('wagtail', 'wagtail', opts) | |
| 101 | + end | |
| 102 | + end | |
| 103 | +end | |