History

Merge branch 'master' into mariadb

Jasper van Merle committed 7 years ago

Commit 29337982 parents ad53c65 2eb8654168 files · +874 −358Browse files

Unified · Split

168 files
  1. .github/CONTRIBUTING.md +2 −11
  2. .github/ISSUE_TEMPLATE.md +1 −1
  3. .github/no-response.yml +8 −0
  4. .gitignore +2 −5
  5. .ruby-version +1 −1
  6. COPYRIGHT +4 −4
  7. Dockerfile +1 −1
  8. Dockerfile-alpine +1 −1
  9. Gemfile +6 −5
  10. Gemfile.lock +47 −44
  11. README.md +10 −11
  12. Rakefile +4 −0
  13. assets/javascripts/app/app.coffee +8 −1
  14. assets/javascripts/app/appcache.coffee +1 −1
  15. assets/javascripts/lib/license.coffee +1 −1
  16. assets/javascripts/templates/error_tmpl.coffee +3 −3
  17. assets/javascripts/templates/pages/about_tmpl.coffee +17 −22
  18. assets/javascripts/templates/pages/root_tmpl.coffee.erb +1 −1
  19. assets/javascripts/views/content/offline_page.coffee +1 −0
  20. assets/javascripts/views/layout/document.coffee +1 −1
  21. assets/stylesheets/application.css.scss +1 −1
  22. assets/stylesheets/components/_content.scss +1 −0
  23. assets/stylesheets/components/_fail.scss +0 −2
  24. assets/stylesheets/pages/_mdn.scss +25 −0
  25. assets/stylesheets/pages/_node.scss +3 −0
  26. assets/stylesheets/pages/_rdoc.scss +0 −11
  27. docs/maintainers_guide.md +102 −0
  28. lib/app.rb +2 −2
  29. lib/docs.rb +18 −1
  30. lib/docs/core/doc.rb +6 −0
  31. lib/docs/core/requester.rb +8 −4
  32. lib/docs/core/scrapers/file_scraper.rb +18 −7
  33. lib/docs/core/url.rb +1 −1
  34. lib/docs/filters/codeceptjs/entries.rb +2 −2
  35. lib/docs/filters/cordova/clean_html.rb +1 −1
  36. lib/docs/filters/cpp/entries.rb +2 −0
  37. lib/docs/filters/css/entries.rb +17 −10
  38. lib/docs/filters/dom/clean_html.rb +1 −1
  39. lib/docs/filters/dom/entries.rb +12 −2
  40. lib/docs/filters/haskell/clean_html.rb +4 −0
  41. lib/docs/filters/haskell/entries.rb +2 −2
  42. lib/docs/filters/html/entries.rb +1 −1
  43. lib/docs/filters/javascript/clean_html.rb +2 −2
  44. lib/docs/filters/javascript/entries.rb +1 −1
  45. lib/docs/filters/mdn/clean_html.rb +90 −0
  46. lib/docs/filters/node/clean_html.rb +1 −1
  47. lib/docs/filters/node/entries.rb +2 −0
  48. lib/docs/filters/rdoc/clean_html.rb +4 −2
  49. lib/docs/filters/react/entries.rb +6 −2
  50. lib/docs/filters/redis/entries.rb +1 −1
  51. lib/docs/filters/rust/clean_html.rb +4 −2
  52. lib/docs/filters/rust/entries.rb +5 −6
  53. lib/docs/filters/sqlite/entries.rb +2 −1
  54. lib/docs/scrapers/ansible.rb +21 −1
  55. lib/docs/scrapers/apache.rb +1 −1
  56. lib/docs/scrapers/async.rb +2 −2
  57. lib/docs/scrapers/c.rb +0 −1
  58. lib/docs/scrapers/codeception.rb +1 −1
  59. lib/docs/scrapers/codeceptjs.rb +1 −1
  60. lib/docs/scrapers/cordova.rb +6 −1
  61. lib/docs/scrapers/cpp.rb +0 −1
  62. lib/docs/scrapers/crystal.rb +1 −1
  63. lib/docs/scrapers/d.rb +1 −1
  64. lib/docs/scrapers/d3.rb +1 −1
  65. lib/docs/scrapers/dart.rb +0 −2
  66. lib/docs/scrapers/django.rb +0 −6
  67. lib/docs/scrapers/erlang.rb +0 −4
  68. lib/docs/scrapers/eslint.rb +1 −1
  69. lib/docs/scrapers/flow.rb +1 −1
  70. lib/docs/scrapers/git.rb +1 −1
  71. lib/docs/scrapers/gnu/gcc.rb +0 −8
  72. lib/docs/scrapers/gnu/gnu_fortran.rb +0 −4
  73. lib/docs/scrapers/go.rb +1 −1
  74. lib/docs/scrapers/godot.rb +1 −1
  75. lib/docs/scrapers/graphite.rb +1 −1
  76. lib/docs/scrapers/haskell.rb +1 −1
  77. lib/docs/scrapers/homebrew.rb +2 −3
  78. lib/docs/scrapers/jasmine.rb +1 −1
  79. lib/docs/scrapers/julia.rb +2 −2
  80. lib/docs/scrapers/koa.rb +1 −1
  81. lib/docs/scrapers/leaflet.rb +1 −1
  82. lib/docs/scrapers/matplotlib.rb +29 −11
  83. lib/docs/scrapers/mocha.rb +1 −1
  84. lib/docs/scrapers/nginx.rb +1 −1
  85. lib/docs/scrapers/nim.rb +2 −2
  86. lib/docs/scrapers/node.rb +7 −2
  87. lib/docs/scrapers/nokogiri2.rb +8 −4
  88. lib/docs/scrapers/numpy.rb +0 −1
  89. lib/docs/scrapers/openjdk.rb +2 −3
  90. lib/docs/scrapers/pandas.rb +5 −0
  91. lib/docs/scrapers/perl.rb +0 −1
  92. lib/docs/scrapers/phoenix.rb +1 −1
  93. lib/docs/scrapers/php.rb +2 −3
  94. lib/docs/scrapers/puppeteer.rb +1 −1
  95. lib/docs/scrapers/python.rb +4 −8
  96. lib/docs/scrapers/rdoc/minitest.rb +7 −2
  97. lib/docs/scrapers/rdoc/rails.rb +10 −3
  98. lib/docs/scrapers/rdoc/ruby.rb +8 −19
  99. lib/docs/scrapers/react.rb +1 −1
  100. lib/docs/scrapers/redis.rb +1 −1
  101. lib/docs/scrapers/rust.rb +4 −1
  102. lib/docs/scrapers/scikit_image.rb +2 −2
  103. lib/docs/scrapers/scikit_learn.rb +2 −2
  104. lib/docs/scrapers/sinon.rb +13 −8
  105. lib/docs/scrapers/sqlite.rb +1 −2
  106. lib/docs/scrapers/statsmodels.rb +1 −1
  107. lib/docs/scrapers/symfony.rb +13 −8
  108. lib/docs/scrapers/twig.rb +6 −6
  109. lib/docs/scrapers/typescript.rb +1 −1
  110. lib/docs/scrapers/underscore.rb +4 −4
  111. lib/docs/scrapers/vagrant.rb +1 −1
  112. lib/docs/scrapers/yarn.rb +1 −1
  113. lib/docs/subscribers/requester_subscriber.rb +13 −0
  114. lib/tasks/docs.thor +111 −13
  115. public/favicon.pxm +0 −0
  116. public/favicon@2x.pxm +0 −0
  117. public/icons/docs/css/CSS3.sketch/Data +0 −0
  118. public/icons/docs/css/CSS3.sketch/QuickLook/Preview.png +0 −0
  119. public/icons/docs/css/CSS3.sketch/QuickLook/Thumbnail.png +0 −0
  120. public/icons/docs/css/CSS3.sketch/fonts +0 −0
  121. public/icons/docs/css/CSS3.sketch/version +1 −0
  122. public/icons/docs/dom/DOM.sketch/Data +0 −0
  123. public/icons/docs/dom/DOM.sketch/QuickLook/Preview.png +0 −0
  124. public/icons/docs/dom/DOM.sketch/QuickLook/Thumbnail.png +0 −0
  125. public/icons/docs/dom/DOM.sketch/fonts +0 −0
  126. public/icons/docs/dom/DOM.sketch/version +1 −0
  127. public/icons/docs/dom_events/DOM_events.sketch/Data +0 −0
  128. public/icons/docs/dom_events/DOM_events.sketch/QuickLook/Preview.png +0 −0
  129. public/icons/docs/dom_events/DOM_events.sketch/QuickLook/Thumbnail.png +0 −0
  130. public/icons/docs/dom_events/DOM_events.sketch/fonts +0 −0
  131. public/icons/docs/dom_events/DOM_events.sketch/version +1 −0
  132. public/icons/docs/express/16.pxm +0 −0
  133. public/icons/docs/express/16@2x.pxm +0 −0
  134. public/icons/docs/html/HTML5.sketch/Data +0 −0
  135. public/icons/docs/html/HTML5.sketch/QuickLook/Preview.png +0 −0
  136. public/icons/docs/html/HTML5.sketch/QuickLook/Thumbnail.png +0 −0
  137. public/icons/docs/html/HTML5.sketch/fonts +0 −0
  138. public/icons/docs/html/HTML5.sketch/version +1 −0
  139. public/icons/docs/http/16.pxm +0 −0
  140. public/icons/docs/http/16@2x.pxm +0 −0
  141. public/icons/docs/javascript/16.pxm +0 −0
  142. public/icons/docs/javascript/16@2x.pxm +0 −0
  143. public/icons/docs/knockout/16@2x.pxm +0 −0
  144. public/icons/docs/less/less.pxm +0 −0
  145. public/icons/docs/moment/moment.sketch/Data +0 −0
  146. public/icons/docs/moment/moment.sketch/QuickLook/Preview.png +0 −0
  147. public/icons/docs/moment/moment.sketch/QuickLook/Thumbnail.png +0 −0
  148. public/icons/docs/moment/moment.sketch/fonts +0 −0
  149. public/icons/docs/moment/moment.sketch/metadata +14 −0
  150. public/icons/docs/moment/moment.sketch/version +1 −0
  151. public/icons/docs/nokogiri/icon.pxm +0 −0
  152. public/icons/docs/php/16@2x.pxm +0 −0
  153. public/icons/docs/rails/rails.pxm +0 −0
  154. public/icons/docs/sass/sass.pxm +0 −0
  155. public/icons/docs/support_tables/16.pxm +0 −0
  156. public/icons/docs/support_tables/16@2x.pxm +0 −0
  157. public/icons/docs/xpath/XPath.sketch/Data +0 −0
  158. public/icons/docs/xpath/XPath.sketch/QuickLook/Preview.png +0 −0
  159. public/icons/docs/xpath/XPath.sketch/QuickLook/Thumbnail.png +0 −0
  160. public/icons/docs/xpath/XPath.sketch/metadata +18 −0
  161. public/icons/docs/xpath/XPath.sketch/version +1 −0
  162. public/images/apple-icon.pxm +0 −0
  163. public/images/fluid-icon.pxm +0 −0
  164. public/images/icon.pxm +0 −0
  165. public/images/webapp-icon-small.pxm +0 −0
  166. test/app_test.rb +5 −0
  167. test/lib/docs/core/scrapers/file_scraper_test.rb +89 −47
  168. views/unsupported.erb +3 −3
.github/CONTRIBUTING.mdrenamed from CONTRIBUTING.md+2−11
@@ -27,8 +27,6 @@ Want to contribute? Great. Please review the following guidelines carefully and · 26 unmodified lines
2727 2. Make sure your feature fits DevDocs's [vision](https://github.com/freeCodeCamp/devdocs/blob/master/README.md#vision).
2828 3. Provide a clear and detailed explanation of the feature and why it's important to add it.
2929
30−For general feedback and ideas, please use the [mailing list](https://groups.google.com/d/forum/devdocs).
31−
3230 ## Requesting new documentations
3331
3432 Please don't open issues to request new documentations.
@@ -37,7 +35,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher · 2 unmodified lines
3735 ## Contributing code and features
3836
3937 1. Search for existing issues; someone may already be working on a similar feature.
40−2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something I may not want to merge. This also tells other contributors that you're working on the feature.
38+2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something we may not want to merge. This also tells other contributors that you're working on the feature.
4139 3. Follow the [coding conventions](#coding-conventions).
4240 4. If you're modifying the Ruby code, include tests and ensure they pass.
4341 5. Try to keep your pull request small and simple.
@@ -65,13 +63,6 @@ Please don't submit a pull request updating the version number of a documentatio · 21 unmodified lines
6563
6664 To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/c/2B0hmW7M/52-request-updates-here).
6765
68−## Other contributions
69−
70−Besides new docs and features, here are other ways you can contribute:
71−
72−* **Improve our copy.** English isn't my first language so if you notice grammatical or usage errors, feel free to submit a pull request — it'll be much appreciated.
73−* **Participate in the issue tracker.** Your opinion matters — feel free to add comments to existing issues. You're also welcome to participate to the [mailing list](https://groups.google.com/d/forum/devdocs).
74−
7566 ## Coding conventions
7667
7768 * two spaces; no tabs
@@ -80,4 +71,4 @@ Besides new docs and features, here are other ways you can contribute: · 2 unmodified lines
8071
8172 ## Questions?
8273
83−If you have any questions, please feel free to ask on the [mailing list](https://groups.google.com/d/forum/devdocs).
74+If you have any questions, please feel free to ask them on the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs).
.github/ISSUE_TEMPLATE.mdrenamed from ISSUE_TEMPLATE.md+1−1
@@ -1,6 +1,6 @@
11 <!--
22 Please read the contributing guidelines before opening an issue:
3− https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md
3+ https://github.com/freeCodeCamp/devdocs/blob/master/.github/CONTRIBUTING.md
44
55 To request a new documentation, or an update of an existing documentation, go here:
66 https://trello.com/b/6BmTulfx/devdocs-documentation
.github/no-response.yml+8−0
@@ -0,0 +1,8 @@
1+daysUntilClose: 30
2+responseRequiredLabel: needs-info
3+closeComment: >
4+ This issue has been automatically closed because there has been no response
5+ to our request for more information from the original author. With only the
6+ information that’s currently in the issue, we don’t have enough information
7+ to take action. Please comment if you have or find the answer we need so we
8+ can investigate further.
.gitignore+2−5
@@ -1,11 +1,8 @@
11 .DS_Store
22 .bundle
3−*.pxm
4−*.sketch
53 tmp
64 public/assets
75 public/fonts
86 public/docs/**/*
9−!public/docs/docs.json
10−!public/docs/**/index.json
11−log
7+docs/**/*
8+!docs/*.md
.ruby-version+1−1
@@ -1 +1 @@
1−2.5.1
1+2.6.0
COPYRIGHT+4−4
@@ -1,13 +1,13 @@
1−Copyright 2013-2018 Thibaut Courouble and other contributors
1+Copyright 2013-2019 Thibaut Courouble and other contributors
22
33 This Source Code Form is subject to the terms of the Mozilla Public
44 License, v. 2.0. If a copy of the MPL was not distributed with this
55 file, You can obtain one at http://mozilla.org/MPL/2.0/.
66
77 Please do not use the name DevDocs to endorse or promote products
8−derived from this software without my permission, except as may be
9−necessary to comply with the notice/attribution requirements.
8+derived from this software without the maintainers' permission, except
9+as may be necessary to comply with the notice/attribution requirements.
1010
11−I also wish that any documentation file generated using this software
11+We also wish that any documentation file generated using this software
1212 be attributed to DevDocs. Let's be fair to all contributors by giving
1313 credit where credit's due. Thanks.
Dockerfile+1−1
@@ -1,4 +1,4 @@
1−FROM ruby:2.5.1
1+FROM ruby:2.6.0
22
33 ENV LANG=C.UTF-8
44
Dockerfile-alpine+1−1
@@ -1,4 +1,4 @@
1−FROM ruby:2.5.1-alpine
1+FROM ruby:2.6.0-alpine
22
33 ENV LANG=C.UTF-8
44
Gemfile+6−5
@@ -1,11 +1,14 @@
11 source 'https://rubygems.org'
2−ruby '2.5.1'
2+ruby '2.6.0'
33
44 gem 'rake'
55 gem 'thor'
6−gem 'pry', '~> 0.11.0'
6+gem 'pry', '~> 0.12.0'
77 gem 'activesupport', '~> 5.2', require: false
88 gem 'yajl-ruby', require: false
9+gem 'html-pipeline'
10+gem 'typhoeus'
11+gem 'nokogiri'
912
1013 group :app do
1114 gem 'rack'
@@ -31,14 +34,12 @@ group :development do · 19 unmodified lines
3134 end
3235
3336 group :docs do
34− gem 'typhoeus'
35− gem 'nokogiri'
36− gem 'html-pipeline'
3737 gem 'image_optim'
3838 gem 'image_optim_pack', platforms: :ruby
3939 gem 'progress_bar', require: false
4040 gem 'unix_utils', require: false
4141 gem 'tty-pager', require: false
42+ gem 'net-sftp', '>= 2.1.3.rc2', require: false
4243 end
4344
4445 group :test do
Gemfile.lock+47−44
@@ -1,7 +1,7 @@
11 GEM
22 remote: https://rubygems.org/
33 specs:
4− activesupport (5.2.1)
4+ activesupport (5.2.2)
55 concurrent-ruby (~> 1.0, >= 1.0.2)
66 i18n (>= 0.7, < 2)
77 minitest (~> 5.1)
@@ -17,77 +17,79 @@ GEM · 9 unmodified lines
1717 coffee-script-source
1818 execjs
1919 coffee-script-source (1.12.2)
20− concurrent-ruby (1.0.5)
21− daemons (1.2.6)
22− erubi (1.7.1)
23− ethon (0.11.0)
20+ concurrent-ruby (1.1.4)
21+ daemons (1.3.1)
22+ erubi (1.8.0)
23+ ethon (0.12.0)
2424 ffi (>= 1.3.0)
2525 eventmachine (1.2.7)
2626 execjs (2.7.0)
27− exifr (1.3.4)
28− ffi (1.9.25)
27+ exifr (1.3.5)
28+ ffi (1.10.0)
2929 fspath (3.1.0)
3030 highline (2.0.0)
31− html-pipeline (2.8.4)
31+ html-pipeline (2.10.0)
3232 activesupport (>= 2)
3333 nokogiri (>= 1.4)
34− i18n (1.1.0)
34+ i18n (1.5.2)
3535 concurrent-ruby (~> 1.0)
36− image_optim (0.26.2)
36+ image_optim (0.26.3)
3737 exifr (~> 1.2, >= 1.2.2)
3838 fspath (~> 3.0)
3939 image_size (>= 1.5, < 3)
4040 in_threads (~> 1.3)
4141 progress (~> 3.0, >= 3.0.1)
42− image_optim_pack (0.5.1)
42+ image_optim_pack (0.5.1.20190105)
4343 fspath (>= 2.1, < 4)
4444 image_optim (~> 0.19)
4545 image_size (2.0.0)
46− in_threads (1.5.0)
47− method_source (0.9.0)
48− mini_portile2 (2.3.0)
46+ in_threads (1.5.1)
47+ method_source (0.9.2)
48+ mini_portile2 (2.4.0)
4949 minitest (5.11.3)
5050 multi_json (1.13.1)
5151 mustermann (1.0.3)
52− newrelic_rpm (5.4.0.347)
53− nokogiri (1.8.4)
54− mini_portile2 (~> 2.3.0)
52+ net-sftp (3.0.0.beta1)
53+ net-ssh (>= 5.0.0, < 6.0.0)
54+ net-ssh (5.1.0)
55+ newrelic_rpm (5.7.0.350)
56+ nokogiri (1.10.1)
57+ mini_portile2 (~> 2.4.0)
5558 options (2.3.2)
56− progress (3.4.0)
59+ progress (3.5.0)
5760 progress_bar (1.3.0)
5861 highline (>= 1.6, < 3)
5962 options (~> 2.3.0)
60− pry (0.11.3)
63+ pry (0.12.2)
6164 coderay (~> 1.1.0)
6265 method_source (~> 0.9.0)
63− rack (2.0.5)
64− rack-protection (2.0.4)
66+ rack (2.0.6)
67+ rack-protection (2.0.5)
6568 rack
6669 rack-ssl-enforcer (0.2.9)
6770 rack-test (1.1.0)
6871 rack (>= 1.0, < 3)
69− rake (12.3.1)
72+ rake (12.3.2)
7073 rb-fsevent (0.10.3)
71− rb-inotify (0.9.10)
72− ffi (>= 0.5.0, < 2)
74+ rb-inotify (0.10.0)
75+ ffi (~> 1.0)
7376 rr (1.2.1)
74− sass (3.6.0)
77+ sass (3.7.3)
7578 sass-listen (~> 4.0.0)
7679 sass-listen (4.0.0)
7780 rb-fsevent (~> 0.9, >= 0.9.4)
7881 rb-inotify (~> 0.9, >= 0.9.7)
79− sinatra (2.0.4)
82+ sinatra (2.0.5)
8083 mustermann (~> 1.0)
8184 rack (~> 2.0)
82− rack-protection (= 2.0.4)
85+ rack-protection (= 2.0.5)
8386 tilt (~> 2.0)
84− sinatra-contrib (2.0.4)
85− activesupport (>= 4.0.0)
87+ sinatra-contrib (2.0.5)
8688 backports (>= 2.8.2)
8789 multi_json
8890 mustermann (~> 1.0)
89− rack-protection (= 2.0.4)
90− sinatra (= 2.0.4)
91+ rack-protection (= 2.0.5)
92+ sinatra (= 2.0.5)
9193 tilt (>= 1.3, < 3)
9294 sprockets (3.7.2)
9395 concurrent-ruby (~> 1.0)
@@ -103,22 +105,22 @@ GEM · 9 unmodified lines
103105 daemons (~> 1.0, >= 1.0.9)
104106 eventmachine (~> 1.0, >= 1.0.4)
105107 rack (>= 1, < 3)
106− thor (0.20.0)
108+ thor (0.20.3)
107109 thread_safe (0.3.6)
108− tilt (2.0.8)
109− tty-pager (0.11.0)
110− strings (~> 0.1.0)
111− tty-screen (~> 0.6.4)
112− tty-which (~> 0.3.0)
110+ tilt (2.0.9)
111+ tty-pager (0.12.0)
112+ strings (~> 0.1.4)
113+ tty-screen (~> 0.6)
114+ tty-which (~> 0.4)
113115 tty-screen (0.6.5)
114− tty-which (0.3.0)
115− typhoeus (1.3.0)
116+ tty-which (0.4.0)
117+ typhoeus (1.3.1)
116118 ethon (>= 0.9.0)
117119 tzinfo (1.2.5)
118120 thread_safe (~> 0.1)
119− uglifier (4.1.19)
121+ uglifier (4.1.20)
120122 execjs (>= 0.3.0, < 3)
121− unicode-display_width (1.4.0)
123+ unicode-display_width (1.4.1)
122124 unicode_utils (1.4.0)
123125 unix_utils (0.0.15)
124126 yajl-ruby (1.4.1)
@@ -136,10 +138,11 @@ DEPENDENCIES · 11 unmodified lines
136138 image_optim
137139 image_optim_pack
138140 minitest
141+ net-sftp (>= 2.1.3.rc2)
139142 newrelic_rpm
140143 nokogiri
141144 progress_bar
142− pry (~> 0.11.0)
145+ pry (~> 0.12.0)
143146 rack
144147 rack-ssl-enforcer
145148 rack-test
@@ -159,7 +162,7 @@ DEPENDENCIES · 13 unmodified lines
159162 yajl-ruby
160163
161164 RUBY VERSION
162− ruby 2.5.1p57
165+ ruby 2.6.0p0
163166
164167 BUNDLED WITH
165− 1.16.1
168+ 1.17.2
README.md+10−11
@@ -1,25 +1,24 @@
1−# [DevDocs](https://devdocs.io) [![Build Status](https://travis-ci.org/freeCodeCamp/devdocs.svg?branch=master)](https://travis-ci.org/freeCodeCamp/devdocs)
1+# [DevDocs](https://devdocs.io) — API Documentation Browser [![Build Status](https://travis-ci.org/freeCodeCamp/devdocs.svg?branch=master)](https://travis-ci.org/freeCodeCamp/devdocs)
22
3−DevDocs combines multiple API documentations in a fast, organized, and searchable interface.
3+DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
44
5−* Created by [Thibaut Courouble](https://thibaut.me)
5+DevDocs was created by [Thibaut Courouble](https://thibaut.me) and is operated by [freeCodeCamp](https://www.freecodecamp.org).
66
77 Keep track of development news:
88
99 * Join the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs)
1010 * Watch the repository on [GitHub](https://github.com/freeCodeCamp/devdocs/subscription)
1111 * Follow [@DevDocs](https://twitter.com/DevDocs) on Twitter
12−* Join the [mailing list](https://groups.google.com/d/forum/devdocs)
1312
1413 **Table of Contents:** [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [License](#copyright--license) · [Questions?](#questions)
1514
1615 ## Quick Start
1716
18−Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box.
17+Unless you wish to contribute to the project, we recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box.
1918
2019 DevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.
2120
22−DevDocs requires Ruby 2.5.1, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
21+DevDocs requires Ruby 2.6.0, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
2322
2423 ```
2524 git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
@@ -129,20 +128,20 @@ If multiple versions of Ruby are installed on your system, commands must be run · 103 unmodified lines
129128
130129 ## Contributing
131130
132−Contributions are welcome. Please read the [contributing guidelines](https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md).
131+Contributions are welcome. Please read the [contributing guidelines](https://github.com/freeCodeCamp/devdocs/blob/master/.github/CONTRIBUTING.md).
133132
134133 DevDocs's own documentation is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki).
135134
136135 ## Copyright / License
137136
138−Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors)
137+Copyright 2013-2019 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors)
139138
140139 This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT) and [LICENSE](https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE) files.
141140
142−Please do not use the name DevDocs to endorse or promote products derived from this software without my permission, except as may be necessary to comply with the notice/attribution requirements.
141+Please do not use the name DevDocs to endorse or promote products derived from this software without the maintainers' permission, except as may be necessary to comply with the notice/attribution requirements.
143142
144−I also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks!
143+We also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks!
145144
146145 ## Questions?
147146
148−If you have any questions, please feel free to ask them on the [mailing list](https://groups.google.com/d/forum/devdocs).
147+If you have any questions, please feel free to ask them on the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs).
Rakefile+4−0
@@ -3,6 +3,7 @@ · 2 unmodified lines
33 require 'bundler/setup'
44 require 'thor'
55
6+Bundler.require :default
67 $LOAD_PATH.unshift 'lib'
78
89 task :default do
@@ -13,6 +14,9 @@ end · 4 unmodified lines
1314 namespace :assets do
1415 desc 'Compile all assets'
1516 task :precompile do
17+ load 'tasks/docs.thor'
18+ DocsCLI.new.prepare_deploy
19+
1620 load 'tasks/assets.thor'
1721 AssetsCLI.new.compile
1822 end
assets/javascripts/app/app.coffee+8−1
@@ -157,10 +157,17 @@ · 156 unmodified lines
157157 new app.views.Updates()
158158 @updateChecker = new app.UpdateChecker()
159159
160+ reboot: ->
161+ if location.pathname isnt '/' and location.pathname isnt '/settings'
162+ window.location = "/##{location.pathname}"
163+ else
164+ window.location = '/'
165+ return
166+
160167 reload: ->
161168 @docs.clearCache()
162169 @disabledDocs.clearCache()
163− if @appCache then @appCache.reload() else window.location = '/'
170+ if @appCache then @appCache.reload() else @reboot()
164171 return
165172
166173 reset: ->
assets/javascripts/app/appcache.coffee+1−1
@@ -27,7 +27,7 @@ class app.AppCache · 26 unmodified lines
2727 return
2828
2929 reload: ->
30− $.on @cache, 'updateready noupdate error', -> window.location = '/'
30+ $.on @cache, 'updateready noupdate error', -> app.reboot()
3131 @notifyUpdate = false
3232 @notifyProgress = true
3333 try @cache.update() catch
assets/javascripts/lib/license.coffee+1−1
@@ -1,5 +1,5 @@
11 ###
2− * Copyright 2013-2018 Thibaut Courouble and other contributors
2+ * Copyright 2013-2019 Thibaut Courouble and other contributors
33 *
44 * This source code is licensed under the terms of the Mozilla
55 * Public License, v. 2.0, a copy of which may be obtained at:
assets/javascripts/templates/error_tmpl.coffee+3−3
@@ -62,12 +62,12 @@ app.templates.unsupportedBrowser = """ · 61 unmodified lines
6262 <li>iOS 10+
6363 </ul>
6464 <p class="_fail-text">
65− If you're unable to upgrade, I apologize.
66− I decided to prioritize speed and new features over support for older browsers.
65+ If you're unable to upgrade, we apologize.
66+ We decided to prioritize speed and new features over support for older browsers.
6767 <p class="_fail-text">
6868 Note: if you're already using one of the browsers above, check your settings and add-ons.
6969 The app uses feature detection, not user agent sniffing.
7070 <p class="_fail-text">
71− &mdash; Thibaut <a href="https://twitter.com/DevDocs" class="_fail-link">@DevDocs</a>
71+ &mdash; <a href="https://twitter.com/DevDocs">@DevDocs</a>
7272 </div>
7373 """
assets/javascripts/templates/pages/about_tmpl.coffee+17−22
@@ -11,22 +11,18 @@ app.templates.aboutPage = -> """ · 10 unmodified lines
1111 </nav>
1212
1313 <h1 class="_lined-heading">DevDocs: API Documentation Browser</h1>
14− <p>DevDocs combines multiple API documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
15− <ul>
16− <li>Created and maintained by <a href="https://thibaut.me">Thibaut Courouble</a>
17− <li>Free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>
18− <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe>
19− </ul>
14+ <p>DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
15+ <p>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>. It was created by <a href="https://thibaut.me">Thibaut Courouble</a> and is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a>.
2016 <p>To keep up-to-date with the latest news:
2117 <ul>
2218 <li>Follow <a href="https://twitter.com/DevDocs">@DevDocs</a> on Twitter
23− <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a>
24− <li>Join the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>
19+ <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a> <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe>
20+ <li>Join the <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a> chat room
2521 </ul>
2622
2723 <h2 class="_block-heading" id="copyright">Copyright and License</h2>
2824 <p class="_note">
29− <strong>Copyright 2013&ndash;2018 Thibaut Courouble and <a href="https://github.com/freeCodeCamp/devdocs/graphs/contributors">other contributors</a></strong><br>
25+ <strong>Copyright 2013&ndash;2019 Thibaut Courouble and <a href="https://github.com/freeCodeCamp/devdocs/graphs/contributors">other contributors</a></strong><br>
3026 This software is licensed under the terms of the Mozilla Public License v2.0.<br>
3127 You may obtain a copy of the source code at <a href="https://github.com/freeCodeCamp/devdocs">github.com/freeCodeCamp/devdocs</a>.<br>
3228 For more information, see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a>
@@ -48,11 +44,10 @@ app.templates.aboutPage = -> """ · 15 unmodified lines
4844 <dt>Where can I suggest new docs and features?
4945 <dd>You can suggest and vote for new docs on the <a href="https://trello.com/b/6BmTulfx/devdocs-documentation">Trello board</a>.<br>
5046 If you have a specific feature request, add it to the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>.<br>
51− Otherwise use the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>.
47+ Otherwise, come talk to us in the <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a> chat room.
5248 <dt>Where can I report bugs?
5349 <dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks!
5450 </dl>
55− <p>For anything else, feel free to email me at <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>.
5651
5752 <h2 class="_block-heading" id="credits">Credits</h2>
5853
@@ -76,12 +71,12 @@ app.templates.aboutPage = -> """ · 17 unmodified lines
7671
7772 <h2 class="_block-heading" id="privacy">Privacy Policy</h2>
7873 <ul>
79− <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by Thibaut Courouble ("We").
80− <li>We do not collect personal information.
74+ <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a> ("We").
75+ <li>We do not collect personal information through the app.
8176 <li>We use Google Analytics, Gauges and Sentry to collect anonymous traffic information and improve the app.
8277 <li>The app uses cookies to store user preferences.
8378 <li>By using the app, you signify your acceptance of this policy. If you do not agree to this policy, please do not use the app.
84− <li>If you have any questions regarding privacy, please email <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>.
79+ <li>If you have any questions regarding privacy, please email <a href="mailto:privacy@freecodecamp.org">privacy@freecodecamp.org</a>.
8580 </ul>
8681 """
8782
@@ -102,7 +97,7 @@ credits = [ · 14 unmodified lines
10297 'https://www.apache.org/licenses/LICENSE-2.0'
10398 ], [
10499 'Async',
105− '2010-2017 Caolan McMahon',
100+ '2010-2018 Caolan McMahon',
106101 'MIT',
107102 'https://raw.githubusercontent.com/caolan/async/master/LICENSE'
108103 ], [
@@ -192,7 +187,7 @@ credits = [ · 83 unmodified lines
192187 'https://raw.githubusercontent.com/jashkenas/coffeescript/master/LICENSE'
193188 ], [
194189 'Cordova',
195− '2012-2017 The Apache Software Foundation',
190+ '2012-2018 The Apache Software Foundation',
196191 'Apache',
197192 'https://raw.githubusercontent.com/apache/cordova-docs/master/LICENSE'
198193 ], [
@@ -372,7 +367,7 @@ credits = [ · 173 unmodified lines
372367 'https://raw.githubusercontent.com/jquery/api.jqueryui.com/master/LICENSE.txt'
373368 ], [
374369 'Julia',
375− '2009-2016 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and other contributors',
370+ '2009-2018 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and other contributors',
376371 'MIT',
377372 'https://raw.githubusercontent.com/JuliaLang/julia/master/LICENSE.md'
378373 ], [
@@ -447,7 +442,7 @@ credits = [ · 68 unmodified lines
447442 'https://daringfireball.net/projects/markdown/license'
448443 ], [
449444 'Matplotlib',
450− '2012-2017 Matplotlib Development Team. All rights reserved.',
445+ '2012-2018 Matplotlib Development Team. All rights reserved.',
451446 'Custom',
452447 'https://raw.githubusercontent.com/matplotlib/matplotlib/master/LICENSE/LICENSE'
453448 ], [
@@ -652,7 +647,7 @@ credits = [ · 198 unmodified lines
652647 'http://scikit-image.org/docs/dev/license.html'
653648 ], [
654649 'scikit-learn',
655− '2007-2017 The scikit-learn developers',
650+ '2007-2018 The scikit-learn developers',
656651 'BSD',
657652 'https://raw.githubusercontent.com/scikit-learn/scikit-learn/master/COPYING'
658653 ], [
@@ -697,9 +692,9 @@ credits = [ · 38 unmodified lines
697692 'https://raw.githubusercontent.com/hashicorp/terraform-website/master/LICENSE.md'
698693 ], [
699694 'Twig',
700− '2009-2017 The Twig Team',
695+ '2009-2018 The Twig Team',
701696 'BSD',
702− 'https://twig.sensiolabs.org/license'
697+ 'https://twig.symfony.com/license'
703698 ], [
704699 'TypeScript',
705700 'Microsoft and other contributors',
@@ -707,7 +702,7 @@ credits = [ · 1 unmodified line
707702 'https://raw.githubusercontent.com/Microsoft/TypeScript-Handbook/master/LICENSE'
708703 ], [
709704 'Underscore.js',
710− '2009-2017 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors',
705+ '2009-2018 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors',
711706 'MIT',
712707 'https://raw.githubusercontent.com/jashkenas/underscore/master/LICENSE'
713708 ], [
assets/javascripts/templates/pages/root_tmpl.coffee.erb+1−1
@@ -14,7 +14,7 @@ app.templates.intro = """ · 13 unmodified lines
1414 <li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.
1515 <li>To be notified about new versions, don't forget to <a href="https://github.com/freeCodeCamp/devdocs/subscription">watch the repository</a> on GitHub.
1616 <li>The <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a> is the preferred channel for bug reports and
17− feature requests. For everything else, use the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>.
17+ feature requests. For everything else, use <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a>.
1818 <li>Contributions are welcome. See the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md">guidelines</a>.
1919 <li>DevDocs is licensed under the terms of the Mozilla Public License v2.0. For more information,
2020 see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a> and
assets/javascripts/views/content/offline_page.coffee+1−0
@@ -57,6 +57,7 @@ class app.views.OfflinePage extends app.View · 56 unmodified lines
5757 doc[action](@onInstallSuccess.bind(@, doc), @onInstallError.bind(@, doc), @onInstallProgress.bind(@, doc))
5858 el.parentNode.innerHTML = "#{el.textContent.replace(/e$/, '')}ing…"
5959 else if action = el.getAttribute('data-action-all')
60+ return unless action isnt 'uninstall' or window.confirm('Uninstall all docs?')
6061 app.db.migrate()
6162 $.click(el) for el in @findAll("[data-action='#{action}']")
6263 return
assets/javascripts/views/layout/document.coffee+1−1
@@ -77,7 +77,7 @@ class app.views.Document extends app.View · 76 unmodified lines
7777 switch target.getAttribute('data-behavior')
7878 when 'back' then history.back()
7979 when 'reload' then window.location.reload()
80− when 'reboot' then window.location = '/'
80+ when 'reboot' then app.reboot()
8181 when 'hard-reload' then app.reload()
8282 when 'reset' then app.reset() if confirm('Are you sure you want to reset DevDocs?')
8383 return
assets/stylesheets/application.css.scss+1−1
@@ -4,7 +4,7 @@ · 3 unmodified lines
44 //= depend_on docs-2@2x.png
55
66 /*!
7− * Copyright 2013-2018 Thibaut Courouble and other contributors
7+ * Copyright 2013-2019 Thibaut Courouble and other contributors
88 *
99 * This source code is licensed under the terms of the Mozilla
1010 * Public License, v. 2.0, a copy of which may be obtained at:
assets/stylesheets/components/_content.scss+1−0
@@ -460,4 +460,5 @@ · 459 unmodified lines
460460 display: inline-block;
461461 vertical-align: text-top;
462462 margin-left: .25rem;
463+ background: inherit;
463464 }
assets/stylesheets/components/_fail.scss+0−2
@@ -32,5 +32,3 @@ · 31 unmodified lines
3232 }
3333
3434 ._fail-text:last-child { margin: 0; }
35−
36−._fail-link { float: right; }
assets/stylesheets/pages/_mdn.scss+25−0
@@ -30,6 +30,7 @@ · 29 unmodified lines
3030 .notice,
3131 .warning,
3232 .overheadIndicator,
33+ .blockIndicator,
3334 .syntaxbox, // CSS, JavaScript
3435 .twopartsyntaxbox, // CSS
3536 .inheritsbox, // JavaScript
@@ -104,4 +105,28 @@ · 68 unmodified lines
104105 .cleared { clear: both; } // CSS/box-shadow
105106
106107 code > strong { font-weight: normal; }
108+
109+ // Compatibility tablees
110+
111+ .bc-github-link {
112+ float: right;
113+ font-size: .75rem;
114+ }
115+
116+ .bc-supports-yes, .bc-supports-yes + dd, .bc-supports-yes + dd + dd { background: var(--noteGreenBackground); }
117+ .bc-supports-partial, .bc-supports-partial + dd, .bc-supports-partial + dd + dd { background: var(--noteOrangeBackground); }
118+ .bc-supports-no, .bc-supports-no + dd, .bc-supports-no + dd + dd { background: var(--noteRedBackground); }
119+
120+ .bc-table {
121+ min-width: 100%;
122+
123+ dl {
124+ margin: .25rem 0 0;
125+ padding: .25rem 0 0;
126+ font-size: .75rem;
127+ border-top: 1px solid var(--boxBorder);
128+ }
129+
130+ dd { margin: 0; }
131+ }
107132 }
assets/stylesheets/pages/_node.scss+3−0
@@ -20,5 +20,8 @@ · 19 unmodified lines
2020 margin: 0 0 1em 1em;
2121 @extend %label;
2222 }
23+
24+ .srclink { float: right; }
25+ details > table { margin: 0; }
2326 }
2427
assets/stylesheets/pages/_rdoc.scss+0−11
@@ -33,19 +33,8 @@ · 32 unmodified lines
3333 }
3434 }
3535
36− .method-description { position: relative; }
37−
3836 .method-source-code {
3937 display: none;
40− position: absolute;
41− z-index: 1;
42− top: 0;
43− left: -1em;
44− right: 0;
45− background: var(--contentBackground);
46− box-shadow: 0 1em 1em 1em var(--contentBackground);
47−
48− > pre { margin: 0; }
4938 }
5039
5140 // Rails guides
docs/maintainers_guide.md+102−0
@@ -0,0 +1,102 @@
1+# Maintainer's Guide
2+
3+This document is intended for [DevDocs maintainers](#list-of-maintainers).
4+
5+## Merging pull requests
6+
7+- Unless the change is trivial or in an area that you are familiar with, PRs should be approved by at least two maintainers before being merged.
8+
9+- PRs that add or update documentations should always be merged locally, and the app deployed, before the merge is pushed to GitHub.
10+
11+ This workflow is required because there is a dependency between the local and production environments. The `thor docs:download` command downloads documentations from production files uploaded by the `thor docs:upload` command. If a PR adding a new documentation is merged and pushed to GitHub before the files have been uploaded to production, the `thor docs:download` will fail for the new documentation and the docker container will not build properly until the new documentation is deployed to production.
12+
13+## Updating docs
14+
15+The process for updating docs is as follow:
16+
17+- Make version/release changes in the scraper file.
18+- If needed, update the copyright notice of the documentation in the scraper file (`options[:attribution]`) and the about page (`about_tmpl.coffee`). The copyright notice must be the same as the one on the original documentation.
19+- Run `thor docs:generate`.
20+- Make sure the documentation still works well. The `thor docs:generate` command outputs a summary of the changes, which helps identifying issues (e.g. deleted files) and new pages to check out in the app. Verify locally that everything works, especially the files that were created (if any), and that the categorization of entries is still good. Often, updates will require code changes to tweak some new markup in the source website or categorize new entries.
21+- Commit the changes (protip: use the `thor docs:commit` command documented below).
22+- Optional: do more updates.
23+- Run `thor docs:upload` (documented below).
24+- [Deploy the app](#deploying-devdocs) and verify that everything works in production.
25+- Push to GitHub.
26+- Run `thor docs:clean` (documented below).
27+
28+Note: changes to `public/docs/docs.json` should never be committed. This file reflects which documentations have been downloaded or generated locally, which is always none on a fresh `git clone`.
29+
30+## Setup requirements
31+
32+In order to deploy DevDocs, you must:
33+
34+- be given access to Heroku, [configure the Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) on your computer, and familiarize yourself with Heroku's UI and CLI, as well as that of New Relic (accessible through [the Heroku dashboard](https://dashboard.heroku.com/apps/devdocs)).
35+
36+- be given access to DevDocs's [Sentry instance](https://sentry.io/devdocs/devdocs-js/) (for JS error tracking) and familiarize yourself with its UI.
37+
38+- be provided with DevDocs's S3 credentials, and install (`brew install awscli` on macOS) and [configure](https://docs.aws.amazon.com/cli/latest/reference/configure/) the AWS CLI on your computer. The configuration must add a named profile called "devdocs":
39+ ```
40+ aws configure --profile devdocs
41+ ```
42+
43+- be provided with DevDocs's MaxCDN push zone credentials, and add them to your `.bash_profile` as such:
44+ ```
45+ export DEVDOCS_DL_USERNAME="username"
46+ export DEVDOCS_DL_PASSWORD="password"
47+ ```
48+
49+## Thor commands
50+
51+In addition to the [publicly-documented commands](https://github.com/freeCodeCamp/devdocs#available-commands), the following commands are aimed at DevDocs maintainers:
52+
53+- `thor docs:package`
54+
55+ Generates packages for one or more documentations. Those packages are intended to be uploaded to DevDocs's MaxCDN push zone by maintainers via the `thor docs:upload` command, and downloaded by users via the `thor docs:download` command.
56+
57+ Versions can be specified as such: `thor docs:package rails@5.2 node@10\ LTS`.
58+
59+ Packages can also be automatically generated during the scraping process by passing the `--package` option to `thor docs:generate`.
60+
61+- `thor docs:upload`
62+
63+ This command does two operations:
64+
65+ 1. sync the files for the specified documentations with S3 (used by the Heroku app);
66+ 2. upload the documentations' packages to DevDocs's MaxCDN push zone (used by the `thor docs:download` command).
67+
68+ For the command to work, you must have the AWS CLI and MaxCDN credentials configured as indicated above.
69+
70+ **Important:** the app should always be deployed immediately after this command has finished running. Do not run this command unless you are able and ready to deploy DevDocs.
71+
72+ To upload all documentations that are packaged on your computer, run `thor docs:upload --packaged`.
73+ To test your configuration and the effect of this command without uploading anything, pass the `--dryrun` option.
74+
75+- `thor docs:commit`
76+
77+ Shortcut command to create a Git commit for a given documentation once it has been updated. Scraper and `assets/` file changes will be committed. The commit message will include the most recent version that the documentation was updated to. If some files were missed by the commit, use `git commit --amend` to add them to the commit. The command may be run before `thor docs:upload` is run, but the commit should not be pushed to GitHub before the files have been uploaded and the app deployed.
78+
79+- `thor docs:clean`
80+
81+ Shortcut command to delete all package files (once uploaded via `thor docs:upload`, they are not needed anymore).
82+
83+## Deploying DevDocs
84+
85+Once docs have been uploaded via `thor docs:upload` (if applicable), deploying DevDocs is as simple as running `git push heroku master`. See [Heroku's documentation](https://devcenter.heroku.com/articles/git) for more information.
86+
87+- If you're deploying documentation updates, verify that the documentations work properly once the deploy is done (you will need to reload [devdocs.io](https://devdocs.io/) a couple times for the application cache to update and the new version to load).
88+- If you're deploying frontend changes, monitor [Sentry](https://sentry.io/devdocs/devdocs-js/) for new JS errors once the deploy is done.
89+- If you're deploying server changes, monitor New Relic (accessible through [the Heroku dashboard](https://dashboard.heroku.com/apps/devdocs)) for Ruby exceptions and throughput or response time changes once the deploy is done.
90+
91+If any issue arises, run `heroku rollback` to rollback to the previous of the app (this can also be done via Heroku's UI). Note that this will not revert changes made to documentation files that were uploaded via `thor docs:upload`. Try and fix the issue as quickly as possible, then re-deploy the app. Reach out to other maintainers if you need help.
92+
93+If this is your first deploy, make sure another maintainer is around to assist.
94+
95+## List of maintainers
96+
97+- [Beau Carnes](https://github.com/beaucarnes)
98+- [Jed Fox](https://github.com/j-f1)
99+- [Jasper van Merle](https://github.com/jmerle)
100+- [Thibaut Courouble](https://github.com/thibaut)
101+
102+Interested in helping maintain DevDocs? Come talk to us on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs) :)
lib/app.rb+2−2
@@ -12,7 +12,7 @@ class App < Sinatra::Application · 11 unmodified lines
1212 Rack::Mime::MIME_TYPES['.webapp'] = 'application/x-web-app-manifest+json'
1313
1414 configure do
15− use Rack::SslEnforcer, only_environments: ['production', 'test'], hsts: false, force_secure_cookies: false
15+ use Rack::SslEnforcer, only_environments: ['production', 'test'], hsts: true, force_secure_cookies: false
1616
1717 set :sentry_dsn, ENV['SENTRY_DSN']
1818 set :protection, except: [:frame_options, :xss_header]
@@ -69,7 +69,7 @@ class App < Sinatra::Application · 50 unmodified lines
6969 set :static, false
7070 set :cdn_origin, 'https://cdn.devdocs.io'
7171 set :docs_origin, '//docs.devdocs.io'
72− set :csp, "default-src 'self' *; script-src 'self' 'nonce-devdocs' http://cdn.devdocs.io https://cdn.devdocs.io https://www.google-analytics.com https://secure.gaug.es http://*.jquery.com https://*.jquery.com; font-src 'none'; style-src 'self' 'unsafe-inline' *; img-src 'self' * data:;"
72+ set :csp, "default-src 'self' *; script-src 'self' 'nonce-devdocs' https://cdn.devdocs.io https://www.google-analytics.com https://secure.gaug.es https://*.jquery.com; font-src 'none'; style-src 'self' 'unsafe-inline' *; img-src 'self' * data:;"
7373
7474 use Rack::ConditionalGet
7575 use Rack::ETag
lib/docs.rb+18−1
@@ -1,5 +1,5 @@
11 require 'bundler/setup'
2−Bundler.require :docs
2+Bundler.require :default, :docs
33
44 require 'active_support'
55 require 'active_support/core_ext'
@@ -29,6 +29,7 @@ module Docs · 23 unmodified lines
2929 self.rescue_errors = false
3030
3131 class DocNotFound < NameError; end
32+ class SetupError < StandardError; end
3233
3334 def self.all
3435 Dir["#{root_path}/docs/scrapers/**/*.rb"].
@@ -74,6 +75,22 @@ module Docs · 39 unmodified lines
7475 end
7576 end
7677
78+ def self.find_by_slug(slug, version = nil)
79+ doc = all.find { |klass| klass.slug == slug }
80+
81+ unless doc
82+ raise DocNotFound.new(%(could not find doc with "#{slug}"), slug)
83+ end
84+
85+ if version.present?
86+ version = doc.versions.find { |klass| klass.version == version || klass.version_slug == version }
87+ raise DocNotFound.new(%(could not find version "#{version}" for doc "#{doc.name}"), doc.name) unless version
88+ doc = version
89+ end
90+
91+ doc
92+ end
93+
7794 def self.generate_page(name, version, page_id)
7895 find(name, version).store_page(store, page_id)
7996 end
lib/docs/core/doc.rb+6−0
@@ -95,6 +95,9 @@ module Docs · 94 unmodified lines
9595 false
9696 end
9797 end
98+ rescue Docs::SetupError => error
99+ puts "ERROR: #{error.message}"
100+ false
98101 end
99102
100103 def store_pages(store)
@@ -118,6 +121,9 @@ module Docs · 17 unmodified lines
118121 false
119122 end
120123 end
124+ rescue Docs::SetupError => error
125+ puts "ERROR: #{error.message}"
126+ false
121127 end
122128
123129 private
lib/docs/core/requester.rb+8−4
@@ -1,5 +1,7 @@
11 module Docs
22 class Requester < Typhoeus::Hydra
3+ include Instrumentable
4+
35 attr_reader :request_options
46
57 def self.run(urls, options = {}, &block)
@@ -20,7 +22,7 @@ module Docs · 14 unmodified lines
2022 def initialize(options = {})
2123 @request_options = options.extract!(:request_options)[:request_options].try(:dup) || {}
2224 options[:max_concurrency] ||= 20
23− options[:pipelining] = false
25+ options[:pipelining] = 0
2426 super
2527 end
2628
@@ -52,9 +54,11 @@ module Docs · 25 unmodified lines
5254 end
5355
5456 def handle_response(response)
55− on_response.each do |callback|
56− result = callback.call(response)
57− result.each { |url| request(url) } if result.is_a? Array
57+ instrument 'handle_response.requester', url: response.url do
58+ on_response.each do |callback|
59+ result = callback.call(response)
60+ result.each { |url| request(url) } if result.is_a?(Array)
61+ end
5862 end
5963 end
6064 end
lib/docs/core/scrapers/file_scraper.rb+18−7
@@ -1,14 +1,13 @@
11 module Docs
22 class FileScraper < Scraper
3+ SOURCE_DIRECTORY = File.expand_path '../../../../../docs', __FILE__
4+
35 Response = Struct.new :body, :url
46
57 class << self
6− attr_accessor :dir
7−
88 def inherited(subclass)
99 super
1010 subclass.base_url = base_url
11− subclass.dir = dir
1211 end
1312 end
1413
@@ -16,13 +15,25 @@ module Docs · 1 unmodified line
1615
1716 html_filters.push 'clean_local_urls'
1817
18+ def source_directory
19+ @source_directory ||= File.join(SOURCE_DIRECTORY, self.class.path)
20+ end
21+
1922 private
2023
24+ def assert_source_directory_exists
25+ unless Dir.exists?(source_directory)
26+ raise SetupError, "The #{self.class.name} scraper requires the original documentation files to be stored in the \"#{source_directory}\" directory."
27+ end
28+ end
29+
2130 def request_one(url)
22− Response.new read_file(file_path_for(url)), URL.parse(url)
31+ assert_source_directory_exists
32+ Response.new read_file(url_to_path(url)), URL.parse(url)
2333 end
2434
2535 def request_all(urls)
36+ assert_source_directory_exists
2637 queue = [urls].flatten
2738 until queue.empty?
2839 result = yield request_one(queue.shift)
@@ -34,12 +45,12 @@ module Docs · 5 unmodified lines
3445 response.body.present?
3546 end
3647
37− def file_path_for(url)
38− File.join self.class.dir, url.remove(base_url.to_s)
48+ def url_to_path(url)
49+ url.remove(base_url.to_s)
3950 end
4051
4152 def read_file(path)
42− File.read(path)
53+ File.read(File.join(source_directory, path))
4354 rescue
4455 instrument 'warn.doc', msg: "Failed to open file: #{path}"
4556 nil
lib/docs/core/url.rb+1−1
@@ -72,7 +72,7 @@ module Docs · 71 unmodified lines
7272
7373 if base == dest
7474 ''
75− elsif dest.start_with? File.join(base, '')
75+ elsif dest.start_with?(::File.join(base, ''))
7676 url.path[(path.length)..-1]
7777 end
7878 end
lib/docs/filters/codeceptjs/entries.rb+2−2
@@ -20,8 +20,8 @@ module Docs · 19 unmodified lines
2020 def additional_entries
2121 return [] unless subpath.start_with?('helpers') && subpath != 'helpers/'
2222
23− css('h2').each_with_object [] do |node, entries|
24− next if node['id'] == 'access-from-helpers'
23+ css('h2, h3').each_with_object [] do |node, entries|
24+ next if node['id'] == 'access-from-helpers' || node.content !~ /\s*[a-z_]/
2525 entries << ["#{node.content} (#{name})", node['id']]
2626 end
2727 end
lib/docs/filters/cordova/clean_html.rb+1−1
@@ -2,7 +2,7 @@ module Docs · 1 unmodified line
22 class Cordova
33 class CleanHtmlFilter < Filter
44 def call
5− @doc = at_css('.page-content > div')
5+ @doc = at_css('#page-toc-source') || at_css('.page-content > div')
66
77 at_css('h1').content = 'Apache Cordova' if root_page?
88
lib/docs/filters/cpp/entries.rb+2−0
@@ -31,6 +31,8 @@ module Docs · 30 unmodified lines
3131 'Keywords'
3232 elsif subpath.start_with?('experimental')
3333 'Experimental libraries'
34+ elsif subpath.start_with?('language/')
35+ 'Language'
3436 elsif type = at_css('.t-navbar > div:nth-child(4) > :first-child').try(:content)
3537 type.strip!
3638 type.remove! ' library'
lib/docs/filters/css/entries.rb+17−10
@@ -6,13 +6,16 @@ module Docs · 5 unmodified lines
66 'CSS_Background_and_Borders' => 'Backgrounds & Borders',
77 'CSS_Columns' => 'Multi-column Layout',
88 'CSS_Flexible_Box_Layout' => 'Flexible Box Layout',
9+ 'CSS_Fonts' => 'Fonts',
910 'CSS_Grid_Layout' => 'Grid Layout',
1011 'CSS_Images' => 'Images',
1112 'CSS_Lists_and_Counters' => 'Lists',
1213 'CSS_Transforms' => 'Transforms',
1314 'Media_Queries' => 'Media Queries',
15+ 'filter-function' => 'Filter Effects',
1416 'transform-function' => 'Transforms',
1517 '@media' => 'Media Queries',
18+ 'overscroll' => 'Overscroll',
1619 'text-size-adjust' => 'Miscellaneous',
1720 'resolved_value' => 'Miscellaneous',
1821 'touch-action' => 'Miscellaneous',
@@ -42,7 +45,7 @@ module Docs · 23 unmodified lines
4245 end
4346
4447 def get_type
45− if slug.include?('-webkit') || slug.include?('-moz')
48+ if slug.include?('-webkit') || slug.include?('-moz') || slug.include?('-ms')
4649 'Extensions'
4750 elsif type = TYPE_BY_PATH[slug.split('/').first]
4851 type
@@ -66,19 +69,22 @@ module Docs · 17 unmodified lines
6669 'Pseudo-Elements'
6770 elsif name.start_with?(':')
6871 'Selectors'
72+ elsif name.start_with?('display-')
73+ 'Display'
6974 else
7075 'Miscellaneous'
7176 end
7277 end
7378
7479 STATUSES = {
75− 'spec-Living' => 0,
76− 'spec-REC' => 1,
77− 'spec-CR' => 2,
78− 'spec-PR' => 3,
79− 'spec-LC' => 4,
80− 'spec-WD' => 5,
81− 'spec-ED' => 6
80+ 'spec-Living' => 0,
81+ 'spec-REC' => 1,
82+ 'spec-CR' => 2,
83+ 'spec-PR' => 3,
84+ 'spec-LC' => 4,
85+ 'spec-WD' => 5,
86+ 'spec-ED' => 6,
87+ 'spec-Obsolete' => 7
8288 }
8389
8490 PRIORITY_STATUSES = %w(spec-REC spec-CR)
@@ -86,6 +92,7 @@ module Docs · 1 unmodified line
8692
8793 def get_spec
8894 return unless table = at_css('#Specifications + table') || css('.standard-table').last
95+
8996 specs = table.css('tbody tr').to_a
9097 # [link, span]
9198 specs.map! { |node| [node.at_css('> td:nth-child(1) > a'), node.at_css('> td:nth-child(2) > span')] }
@@ -110,8 +117,8 @@ module Docs · 18 unmodified lines
110117 'shape' => [
111118 %w(rect() Syntax) ],
112119 'timing-function' => [
113− %w(cubic-bezier() The_cubic-bezier()_class_of_timing-functions),
114− %w(steps() The_steps()_class_of_timing-functions),
120+ %w(cubic-bezier()),
121+ %w(steps()),
115122 %w(linear linear),
116123 %w(ease ease),
117124 %w(ease-in ease-in),
lib/docs/filters/dom/clean_html.rb+1−1
@@ -30,7 +30,7 @@ module Docs · 29 unmodified lines
3030 end
3131
3232 # Remove <div> wrapping .overheadIndicator
33− css('div > .overheadIndicator:first-child:last-child').each do |node|
33+ css('div > .overheadIndicator:first-child:last-child', 'div > .blockIndicator:first-child:last-child').each do |node|
3434 node.parent.replace(node)
3535 end
3636
lib/docs/filters/dom/entries.rb+12−2
@@ -6,6 +6,7 @@ module Docs · 5 unmodified lines
66 'EXT_' => 'WebGL',
77 'OES_' => 'WebGL',
88 'WEBGL_' => 'WebGL',
9+ 'Sensor API' => 'Sensors',
910 'Ambient Light' => 'Ambient Light',
1011 'Audio' => 'Audio',
1112 'Battery Status' => 'Battery Status',
@@ -22,10 +23,12 @@ module Docs · 10 unmodified lines
2223 'Encrypted Media Extensions' => 'Encrypted Media',
2324 'Fetch' => 'Fetch',
2425 'File API' => 'File',
26+ 'Fullscreen' => 'Fullscreen',
2527 'Geolocation' => 'Geolocation',
2628 'Geometry' => 'Geometry',
2729 'High Resolution Time' => 'Performance',
2830 'Intersection' => 'Intersection Observer',
31+ 'Keyboard' => 'Keyboard',
2932 'Media Capabilities' => 'Media',
3033 'Media Capture' => 'Media',
3134 'Media Session' => 'Media',
@@ -35,6 +38,7 @@ module Docs · 3 unmodified lines
3538 'MIDI' => 'Audio',
3639 'Navigation Timing' => 'Performance',
3740 'Network Information' => 'Network Information',
41+ 'Orientation Sensor' => 'Sensors',
3842 'Payment' => 'Payments',
3943 'Performance Timeline' => 'Performance',
4044 'Pointer Events' => 'Pointer Events',
@@ -53,11 +57,13 @@ module Docs · 12 unmodified lines
5357 'Web App Manifest' => 'Web App Manifest',
5458 'Budget' => 'Budget',
5559 'Web Authentication' => 'Authentication',
60+ 'Web Locks' => 'Locks',
5661 'Web Workers' => 'Web Workers',
5762 'WebGL' => 'WebGL',
5863 'WebRTC' => 'WebRTC',
5964 'WebUSB' => 'WebUSB',
60− 'WebVR' => 'WebVR' }
65+ 'WebVR' => 'WebVR',
66+ 'WebVTT' => 'WebVTT' }
6167
6268 TYPE_BY_NAME_STARTS_WITH = {
6369 'AbortController' => 'Fetch',
@@ -89,10 +95,12 @@ module Docs · 25 unmodified lines
8995 'Fetch' => 'Fetch',
9096 'File' => 'File',
9197 'GlobalEventHandlers' => 'GlobalEventHandlers',
98+ 'HMDVR' => 'WebVR',
9299 'history' => 'History',
93100 'HTML Drag' => 'Drag & Drop',
94101 'HTML' => 'Elements',
95102 'IDB' => 'IndexedDB',
103+ 'Keyboard' => 'Keyboard',
96104 'location' => 'Location',
97105 'navigator' => 'Navigator',
98106 'MediaKeySession' => 'Encrypted Media',
@@ -122,6 +130,7 @@ module Docs · 23 unmodified lines
122130 'StyleSheet' => 'CSS',
123131 'Stylesheet' => 'CSS',
124132 'SVG' => 'SVG',
133+ 'TextTrack' => 'WebVTT',
125134 'TimeRanges' => 'Media',
126135 'timing' => 'Performance',
127136 'Timing' => 'Performance',
@@ -160,6 +169,7 @@ module Docs · 32 unmodified lines
160169 'timing' => 'Performance',
161170 'Timing' => 'Performance',
162171 'udio' => 'Audio',
172+ 'VRDevice' => 'WebVR',
163173 'WebGL' => 'WebGL',
164174 'WEBGL' => 'WebGL',
165175 'WebRTC' => 'WebRTC',
@@ -239,7 +249,7 @@ module Docs · 73 unmodified lines
239249
240250 def include_default_entry?
241251 return true if type == 'Console'
242− return true unless node = doc.at_css('.overheadIndicator')
252+ return true unless node = doc.at_css('.overheadIndicator, .blockIndicator')
243253 node = node.parent while node.parent != doc
244254 return true if node.previous_element.try(:name).in?(%w(h2 h3))
245255 content = node.content
lib/docs/filters/haskell/clean_html.rb+4−0
@@ -65,6 +65,10 @@ module Docs · 64 unmodified lines
6565 end
6666 end
6767
68+ css('pre code').each do |node|
69+ node.before(node.children).remove
70+ end
71+
6872 doc
6973 end
7074 end
lib/docs/filters/haskell/entries.rb+2−2
@@ -52,7 +52,7 @@ module Docs · 51 unmodified lines
5252 return [] if subpath.start_with?('users_guide')
5353 return [] if IGNORE_ENTRIES_PATHS.include?(subpath.split('/').last)
5454
55− css('#synopsis > ul > li').each_with_object [] do |node, entries|
55+ css('#synopsis > details > ul > li').each_with_object [] do |node, entries|
5656 link = node.at_css('a')
5757 name = node.content.strip
5858 name.remove! %r{\A(?:module|data|newtype|class|type family m|type)\s+}
@@ -75,7 +75,7 @@ module Docs · 16 unmodified lines
7575 end
7676
7777 def include_default_entry?
78− subpath.start_with?('users_guide') || at_css('#synopsis > ul > li')
78+ subpath.start_with?('users_guide') || at_css('#synopsis > details > ul > li')
7979 end
8080 end
8181 end
lib/docs/filters/html/entries.rb+1−1
@@ -28,7 +28,7 @@ module Docs · 27 unmodified lines
2828
2929 def include_default_entry?
3030 return false if %w(Element/Heading_Elements).include?(slug)
31− (node = doc.at_css '.overheadIndicator').nil? || node.content.exclude?('not on a standards track')
31+ (node = doc.at_css '.overheadIndicator, .blockIndicator').nil? || node.content.exclude?('not on a standards track')
3232 end
3333
3434 def additional_entries
lib/docs/filters/javascript/clean_html.rb+2−2
@@ -11,12 +11,12 @@ module Docs · 10 unmodified lines
1111
1212 def other
1313 # Remove "style" attribute
14− css('.inheritsbox', '.overheadIndicator').each do |node|
14+ css('.inheritsbox', '.overheadIndicator', '.blockIndicator').each do |node|
1515 node.remove_attribute 'style'
1616 end
1717
1818 # Remove <div> wrapping .overheadIndicator
19− css('div > .overheadIndicator:first-child:last-child').each do |node|
19+ css('div > .overheadIndicator:first-child:last-child', 'div > .blockIndicator:first-child:last-child').each do |node|
2020 node.parent.replace(node)
2121 end
2222 end
lib/docs/filters/javascript/entries.rb+1−1
@@ -88,7 +88,7 @@ module Docs · 87 unmodified lines
8888 end
8989
9090 def include_default_entry?
91− node = doc.at_css '.overheadIndicator, .warning'
91+ node = doc.at_css '.blockIndicator, .warning'
9292
9393 # Can't use :first-child because #doc is a DocumentFragment
9494 return true unless node && node.parent == doc && !node.previous_element
lib/docs/filters/mdn/clean_html.rb+90−0
@@ -14,6 +14,8 @@ module Docs · 13 unmodified lines
1414 '#Quick_Links',
1515 'hr']
1616
17+ BROWSER_UNNECESSARY_CLASS_REGEX = /\s*bc-browser[\w_-]+/
18+
1719 def call
1820 css(*REMOVE_NODES).remove
1921
@@ -61,6 +63,94 @@ module Docs · 41 unmodified lines
6163 node.previous_element << node
6264 end
6365
66+ # New compatibility tables
67+
68+ css('.bc-data #Legend + dl', '.bc-data #Legend', '.bc-data #Legend_2 + dl', '.bc-data #Legend_2', '.bc-browser-name').remove
69+
70+ css('abbr.only-icon[title="Full support"]',
71+ 'abbr.only-icon[title="Partial support"]',
72+ 'abbr.only-icon[title="No support"]',
73+ 'abbr.only-icon[title="See implementation notes"]').remove
74+
75+ css('.bc-data .ic-altname', '.bc-data .ic-deprecated', '.bc-data .ic-non-standard', '.bc-data .ic-experimental').each do |node|
76+ node.parent.remove
77+ end
78+
79+ css('abbr.only-icon').each do |node|
80+ node.replace(node.content)
81+ end
82+
83+ css('.bc-table .bc-platforms td', '.bc-table .bc-browsers td').each do |node|
84+ node.name = 'th'
85+ end
86+
87+ css('.bc-data').each do |node|
88+ link = node.at_css('.bc-github-link')
89+ prev = node.previous_element
90+ prev = prev.previous_element until prev.name == 'h2'
91+ prev.add_child(link)
92+
93+ node.before(node.children).remove
94+ end
95+
96+ css('.bc-table').each do |node|
97+ desktop_table = node
98+
99+ mobile_table = node.dup
100+ desktop_table.after(mobile_table)
101+
102+ if desktop_table.at_css('.bc-platform-server')
103+ server_table = node.dup
104+ mobile_table.after(server_table)
105+ end
106+
107+ desktop_columns = desktop_table.at_css('th.bc-platform-desktop')['colspan'].to_i
108+ mobile_columns = desktop_table.at_css('th.bc-platform-mobile')['colspan'].to_i
109+
110+ desktop_table.css('.bc-platform-mobile').remove
111+ desktop_table.css('.bc-platform-server').remove
112+ desktop_table.css('.bc-browsers th').to_a[(desktop_columns + 1)..-1].each(&:remove)
113+ desktop_table.css('tr:not(.bc-platforms):not(.bc-browsers)').each do |line|
114+ line.css('td').to_a[(desktop_columns)..-1].each(&:remove)
115+ end
116+
117+ mobile_table.css('.bc-platform-desktop').remove
118+ mobile_table.css('.bc-platform-server').remove
119+ mobile_table.css('.bc-browsers th').to_a[1..(desktop_columns)].each(&:remove)
120+ mobile_table.css('.bc-browsers th').to_a[(mobile_columns + 1)..-1].each(&:remove)
121+ mobile_table.css('tr:not(.bc-platforms):not(.bc-browsers)').each do |line|
122+ line.css('td').to_a[0..(desktop_columns - 1)].each(&:remove)
123+ line.css('td').to_a[(mobile_columns)..-1].each(&:remove)
124+ end
125+
126+ if server_table
127+ server_table.css('.bc-platform-desktop').remove
128+ server_table.css('.bc-platform-mobile').remove
129+ server_table.css('.bc-browsers th').to_a[1..(desktop_columns + mobile_columns)].each(&:remove)
130+ server_table.css('tr:not(.bc-platforms):not(.bc-browsers)').each do |line|
131+ line.css('td').to_a[0..(desktop_columns + mobile_columns - 1)].each(&:remove)
132+ end
133+ end
134+ end
135+
136+ # Reduce page size to make the offline bundle smaller.
137+ css('.bc-supports-unknown').remove_attr('class')
138+ css('td[class*="bc-platform"], th[class*="bc-platform"]').remove_attr('class')
139+ css('td[class*="bc-browser"], th[class*="bc-browser"]').each do |node|
140+ class_name = node['class']
141+ class_name.remove!(BROWSER_UNNECESSARY_CLASS_REGEX)
142+
143+ if class_name.present?
144+ node['class'] = class_name
145+ else
146+ node.remove_attribute('class')
147+ end
148+ end
149+
150+ css('abbr[title*="Compatibility unknown"]').each do |node|
151+ node.before(node.children).remove
152+ end
153+
64154 doc
65155 end
66156 end
lib/docs/filters/node/clean_html.rb+1−1
@@ -16,7 +16,7 @@ module Docs · 15 unmodified lines
1616
1717 css('pre').each do |node|
1818 if lang = node.at_css('code')['class']
19− node['data-language'] = lang.remove('lang-')
19+ node['data-language'] = lang.remove(%r{lang(uage)?-})
2020 end
2121
2222 node.content = node.content
lib/docs/filters/node/entries.rb+2−0
@@ -26,6 +26,7 @@ module Docs · 25 unmodified lines
2626
2727 def get_type
2828 type = at_css('h1').content.strip
29+ type.remove! %r{\[.*\]}
2930 REPLACE_TYPES[type] || "#{type.first.upcase}#{type[1..-1]}"
3031 end
3132
@@ -40,6 +41,7 @@ module Docs · 8 unmodified lines
4041
4142 klass = nil if node.name == 'h2'
4243 name = node.content.strip
44+ name.remove! %r{\s*\[src\]}
4345
4446 # Skip constructors
4547 if name.start_with? 'new '
lib/docs/filters/rdoc/clean_html.rb+4−2
@@ -37,8 +37,10 @@ module Docs · 36 unmodified lines
3737 end
3838
3939 # Add class to differentiate Ruby code from C code
40− css('.method-source-code > pre').each do |node|
41− node['class'] = node.at_css('.ruby-keyword') ? 'ruby' : 'c'
40+ css('.method-source-code').each do |node|
41+ node.parent.prepend_child(node)
42+ pre = node.at_css('pre')
43+ pre['class'] = pre.at_css('.ruby-keyword') ? 'ruby' : 'c'
4244 end
4345
4446 # Remove code highlighting
lib/docs/filters/react/entries.rb+6−2
@@ -6,9 +6,11 @@ module Docs · 5 unmodified lines
66 end
77
88 def get_type
9− link = at_css("nav a[href='#{result[:path].split('/').last}']")
9+ link = css("nav a[href='#{result[:path].split('/').last}']").last
1010 return 'Miscellaneous' unless link
11− link.ancestors('ul').last.previous_element.content
11+ type = link.ancestors('ul').last.previous_element.content
12+ type.remove! %r{\s*\(.*\)}
13+ type
1214 end
1315
1416 def additional_entries
@@ -25,6 +27,8 @@ module Docs · 10 unmodified lines
2527 'Reference: Component'
2628 elsif slug == 'react-api'
2729 'Reference: React'
30+ elsif slug == 'hooks-reference'
31+ 'Hooks'
2832 else
2933 'Reference'
3034 end
lib/docs/filters/redis/entries.rb+1−1
@@ -21,7 +21,7 @@ module Docs · 20 unmodified lines
2121 when 'PFADD' then 'HyperLogLog'
2222 when 'CLUSTER ADDSLOTS' then 'Cluster'
2323 when 'GEOADD' then 'Geo'
24− when 'XADD' then 'Stream'
24+ when 'XACK' then 'Stream'
2525 else 'Miscellaneous'
2626 end
2727 end
lib/docs/filters/rust/clean_html.rb+4−2
@@ -1,3 +1,5 @@
1+# frozen_string_literal: true
2+
13 module Docs
24 class Rust
35 class CleanHtmlFilter < Filter
@@ -74,10 +76,10 @@ module Docs · 70 unmodified lines
7476 node.remove
7577 end
7678
77− css('h2 .important-traits', 'h3 .important-traits', 'h4 .important-traits').each do |node|
79+ css('.important-traits').to_a.each_with_index do |node, index|
7880 content = node.at_css('.content.hidden .content')
7981 node.at_css('.content.hidden').replace(content) if content
80− node.parent.after(node)
82+ node.parent.after(node) if node.parent.name.in?(%(h2 h3 h4))
8183 end
8284
8385 css('code.content').each do |node|
lib/docs/filters/rust/entries.rb+5−6
@@ -43,13 +43,12 @@ module Docs · 42 unmodified lines
4343 end
4444 else
4545 css('.method')
46− .select {|node| !node.at_css('.fnname').nil?}
47− .map {|node|
48− name = node.at_css('.fnname').content
46+ .each_with_object({}) { |node, entries|
47+ name = node.at_css('.fnname').try(:content)
48+ next unless name
4949 name.prepend "#{self.name}::"
50− [name, node['id']]
51− }
52− .uniq {|item| item[0]}
50+ entries[name] ||= [name, node['id']]
51+ }.values
5352 end
5453 end
5554 end
lib/docs/filters/sqlite/entries.rb+2−1
@@ -34,7 +34,8 @@ module Docs · 33 unmodified lines
3434 'rtree' => 'R*Tree Module',
3535 'rbu' => 'RBU Extension',
3636 'limits' => 'Limits',
37− 'howtocorrupt' => 'How To Corrupt'
37+ 'howtocorrupt' => 'How To Corrupt',
38+ 'geopoly' => 'Geopoly'
3839 }
3940
4041 def get_type
lib/docs/scrapers/ansible.rb+21−1
@@ -15,8 +15,28 @@ module Docs · 14 unmodified lines
1515 Licensed under the GNU General Public License version 3.
1616 HTML
1717
18+ version '2.7' do
19+ self.release = '2.7.1'
20+ self.base_url = 'https://docs.ansible.com/ansible/2.7/'
21+
22+ options[:skip] = %w(
23+ installation_guide/index.html
24+ reference_appendices/glossary.html
25+ reference_appendices/faq.html
26+ reference_appendices/tower.html
27+ user_guide/quickstart.html
28+ modules/modules_by_category.html
29+ modules/list_of_all_modules.html)
30+
31+ options[:skip_patterns] = [
32+ /\Acommunity.*/i,
33+ /\Adev_guide.*/i,
34+ /\Aroadmap.*/i,
35+ ]
36+ end
37+
1838 version '2.6' do
19− self.release = '2.6.1'
39+ self.release = '2.6.7'
2040 self.base_url = 'https://docs.ansible.com/ansible/2.6/'
2141
2242 options[:skip] = %w(
lib/docs/scrapers/apache.rb+1−1
@@ -3,7 +3,7 @@ module Docs · 2 unmodified lines
33 self.name = 'Apache HTTP Server'
44 self.slug = 'apache_http_server'
55 self.type = 'apache'
6− self.release = '2.4.34'
6+ self.release = '2.4.37'
77 self.base_url = 'https://httpd.apache.org/docs/2.4/en/'
88 self.links = {
99 home: 'https://httpd.apache.org/'
lib/docs/scrapers/async.rb+2−2
@@ -1,7 +1,7 @@
11 module Docs
22 class Async < UrlScraper
33 self.type = 'async'
4− self.release = '2.6.0'
4+ self.release = '2.6.1'
55 self.base_url = 'https://caolan.github.io/async/'
66 self.root_path = 'docs.html'
77 self.links = {
@@ -14,7 +14,7 @@ module Docs · 6 unmodified lines
1414 options[:skip_links] = true
1515
1616 options[:attribution] = <<-HTML
17− &copy; 2010&ndash;2017 Caolan McMahon<br>
17+ &copy; 2010&ndash;2018 Caolan McMahon<br>
1818 Licensed under the MIT License.
1919 HTML
2020 end
lib/docs/scrapers/c.rb+0−1
@@ -1,7 +1,6 @@
11 module Docs
22 class C < FileScraper
33 self.type = 'c'
4− self.dir = '/Users/Thibaut/DevDocs/Docs/c'
54 self.base_url = 'http://en.cppreference.com/w/c/'
65 self.root_path = 'header.html'
76
lib/docs/scrapers/codeception.rb+1−1
@@ -2,7 +2,7 @@ module Docs · 1 unmodified line
22 class Codeception < UrlScraper
33 self.name = 'Codeception'
44 self.type = 'codeception'
5− self.release = '2.4.0'
5+ self.release = '2.5.1'
66 self.base_url = 'https://codeception.com/docs/'
77 self.root_path = 'index.html'
88 self.links = {
lib/docs/scrapers/codeceptjs.rb+1−1
@@ -3,7 +3,7 @@ module Docs · 2 unmodified lines
33 self.name = 'CodeceptJS'
44 self.type = 'simple'
55 self.root_path = 'index.html'
6− self.release = '1.3.1'
6+ self.release = '1.4.4'
77 self.base_url = 'https://codecept.io/'
88 self.links = {
99 home: 'https://codecept.io/',
lib/docs/scrapers/cordova.rb+6−1
@@ -24,10 +24,15 @@ module Docs · 23 unmodified lines
2424 end
2525
2626 options[:attribution] = <<-HTML
27− &copy; 2012&ndash;2017 The Apache Software Foundation<br>
27+ &copy; 2012&ndash;2018 The Apache Software Foundation<br>
2828 Licensed under the Apache License 2.0.
2929 HTML
3030
31+ version '8' do
32+ self.release = '8.1.2'
33+ self.base_url = 'https://cordova.apache.org/docs/en/8.x/'
34+ end
35+
3136 version '7' do
3237 self.release = '7.1.0'
3338 self.base_url = 'https://cordova.apache.org/docs/en/7.x/'
lib/docs/scrapers/cpp.rb+0−1
@@ -3,7 +3,6 @@ module Docs · 2 unmodified lines
33 self.name = 'C++'
44 self.slug = 'cpp'
55 self.type = 'c'
6− self.dir = '/Users/Thibaut/DevDocs/Docs/cpp'
76 self.base_url = 'http://en.cppreference.com/w/cpp/'
87 self.root_path = 'header.html'
98
lib/docs/scrapers/crystal.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Crystal < UrlScraper
33 self.type = 'crystal'
4− self.release = '0.26.0'
4+ self.release = '0.27.0'
55 self.base_url = 'https://crystal-lang.org/'
66 self.root_path = "api/#{release}/index.html"
77 self.initial_paths = %w(docs/index.html)
lib/docs/scrapers/d.rb+1−1
@@ -2,7 +2,7 @@ module Docs · 1 unmodified line
22 class D < UrlScraper
33 include MultipleBaseUrls
44
5− self.release = '2.081.0'
5+ self.release = '2.083.0'
66 self.type = 'd'
77 self.base_urls = ['https://dlang.org/phobos/', 'https://dlang.org/spec/']
88 self.root_path = 'index.html'
lib/docs/scrapers/d3.rb+1−1
@@ -17,7 +17,7 @@ module Docs · 16 unmodified lines
1717 HTML
1818
1919 version '5' do
20− self.release = '5.4.0'
20+ self.release = '5.7.0'
2121 self.base_url = 'https://github.com/d3/'
2222 self.root_path = 'd3/blob/master/API.md'
2323
lib/docs/scrapers/dart.rb+0−2
@@ -24,13 +24,11 @@ module Docs · 23 unmodified lines
2424
2525 version '2' do
2626 self.release = '2.0.0'
27− self.dir = '/Users/Thibaut/DevDocs/Docs/Dart2'
2827 self.base_url = "https://api.dartlang.org/stable/#{release}/"
2928 end
3029
3130 version '1' do
3231 self.release = '1.24.3'
33− self.dir = '/Users/Thibaut/DevDocs/Docs/Dart1'
3432 self.base_url = "https://api.dartlang.org/stable/#{release}/"
3533 end
3634 end
lib/docs/scrapers/django.rb+0−6
@@ -36,37 +36,31 @@ module Docs · 35 unmodified lines
3636
3737 version '2.1' do
3838 self.release = '2.1.0'
39− self.dir = '/Users/Thibaut/DevDocs/Docs/Django21'
4039 self.base_url = 'https://docs.djangoproject.com/en/2.1/'
4140 end
4241
4342 version '2.0' do
4443 self.release = '2.0.7'
45− self.dir = '/Users/Thibaut/DevDocs/Docs/Django20'
4644 self.base_url = 'https://docs.djangoproject.com/en/2.0/'
4745 end
4846
4947 version '1.11' do
5048 self.release = '1.11.9'
51− self.dir = '/Users/Thibaut/DevDocs/Docs/Django111'
5249 self.base_url = 'https://docs.djangoproject.com/en/1.11/'
5350 end
5451
5552 version '1.10' do
5653 self.release = '1.10.8'
57− self.dir = '/Users/Thibaut/DevDocs/Docs/Django110'
5854 self.base_url = 'https://docs.djangoproject.com/en/1.10/'
5955 end
6056
6157 version '1.9' do
6258 self.release = '1.9.13'
63− self.dir = '/Users/Thibaut/DevDocs/Docs/Django19'
6459 self.base_url = 'https://docs.djangoproject.com/en/1.9/'
6560 end
6661
6762 version '1.8' do
6863 self.release = '1.8.18'
69− self.dir = '/Users/Thibaut/DevDocs/Docs/Django18'
7064 self.base_url = 'https://docs.djangoproject.com/en/1.8/'
7165 end
7266 end
lib/docs/scrapers/erlang.rb+0−4
@@ -42,22 +42,18 @@ module Docs · 41 unmodified lines
4242
4343 version '21' do
4444 self.release = '21.0'
45− self.dir = '/Users/Thibaut/DevDocs/Docs/Erlang21'
4645 end
4746
4847 version '20' do
4948 self.release = '20.3'
50− self.dir = '/Users/Thibaut/DevDocs/Docs/Erlang20'
5149 end
5250
5351 version '19' do
5452 self.release = '19.3'
55− self.dir = '/Users/Thibaut/DevDocs/Docs/Erlang19'
5653 end
5754
5855 version '18' do
5956 self.release = '18.3'
60− self.dir = '/Users/Thibaut/DevDocs/Docs/Erlang18'
6157 end
6258 end
6359 end
lib/docs/scrapers/eslint.rb+1−1
@@ -2,7 +2,7 @@ module Docs · 1 unmodified line
22 class Eslint < UrlScraper
33 self.name = 'ESLint'
44 self.type = 'simple'
5− self.release = '4.19.0'
5+ self.release = '5.8.0'
66 self.base_url = 'https://eslint.org/docs/'
77 self.root_path = 'user-guide/getting-started'
88 self.links = {
lib/docs/scrapers/flow.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Flow < UrlScraper
33 self.type = 'simple'
4− self.release = '0.79.1'
4+ self.release = '0.85.0'
55 self.base_url = 'https://flow.org/en/docs/'
66 self.links = {
77 home: 'https://flow.org/',
lib/docs/scrapers/git.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Git < UrlScraper
33 self.type = 'git'
4− self.release = '2.17.0'
4+ self.release = '2.19.1'
55 self.base_url = 'https://git-scm.com/docs'
66 self.initial_paths = %w(/git.html)
77 self.links = {
lib/docs/scrapers/gnu/gcc.rb+0−8
@@ -48,13 +48,11 @@ module Docs · 47 unmodified lines
4848
4949 version '7' do
5050 self.release = '7.3.0'
51− self.dir = '/Users/Thibaut/DevDocs/Docs/gcc7'
5251 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gcc/"
5352 end
5453
5554 version '7 CPP' do
5655 self.release = '7.3.0'
57− self.dir = '/Users/Thibaut/DevDocs/Docs/gcpp7'
5856 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/cpp/"
5957
6058 options[:replace_paths] = CPP_PATHS
@@ -62,7 +60,6 @@ module Docs · 1 unmodified line
6260
6361 version '6' do
6462 self.release = '6.4.0'
65− self.dir = '/Users/Thibaut/DevDocs/Docs/gcc6'
6663 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gcc/"
6764
6865 options[:root_title] = 'Using the GNU Compiler Collection (GCC)'
@@ -70,7 +67,6 @@ module Docs · 1 unmodified line
7067
7168 version '6 CPP' do
7269 self.release = '6.4.0'
73− self.dir = '/Users/Thibaut/DevDocs/Docs/gcpp6'
7470 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/cpp/"
7571
7672 options[:replace_paths] = CPP_PATHS
@@ -78,7 +74,6 @@ module Docs · 1 unmodified line
7874
7975 version '5' do
8076 self.release = '5.4.0'
81− self.dir = '/Users/Thibaut/DevDocs/Docs/gcc5'
8277 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gcc/"
8378
8479 options[:root_title] = 'Using the GNU Compiler Collection (GCC)'
@@ -86,7 +81,6 @@ module Docs · 1 unmodified line
8681
8782 version '5 CPP' do
8883 self.release = '5.4.0'
89− self.dir = '/Users/Thibaut/DevDocs/Docs/gcpp5'
9084 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/cpp/"
9185
9286 options[:replace_paths] = CPP_PATHS
@@ -94,7 +88,6 @@ module Docs · 1 unmodified line
9488
9589 version '4' do
9690 self.release = '4.9.3'
97− self.dir = '/Users/Thibaut/DevDocs/Docs/gcc4'
9891 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gcc/"
9992
10093 options[:root_title] = 'Using the GNU Compiler Collection (GCC)'
@@ -102,7 +95,6 @@ module Docs · 1 unmodified line
10295
10396 version '4 CPP' do
10497 self.release = '4.9.3'
105− self.dir = '/Users/Thibaut/DevDocs/Docs/gcpp4'
10698 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/cpp/"
10799
108100 options[:replace_paths] = CPP_PATHS
lib/docs/scrapers/gnu/gnu_fortran.rb+0−4
@@ -8,25 +8,21 @@ module Docs · 7 unmodified lines
88
99 version '7' do
1010 self.release = '7.3.0'
11− self.dir = '/Users/Thibaut/DevDocs/Docs/gfortran7'
1211 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gfortran/"
1312 end
1413
1514 version '6' do
1615 self.release = '6.4.0'
17− self.dir = '/Users/Thibaut/DevDocs/Docs/gfortran6'
1816 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gfortran/"
1917 end
2018
2119 version '5' do
2220 self.release = '5.4.0'
23− self.dir = '/Users/Thibaut/DevDocs/Docs/gfortran5'
2421 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gfortran/"
2522 end
2623
2724 version '4' do
2825 self.release = '4.9.3'
29− self.dir = '/Users/Thibaut/DevDocs/Docs/gfortran4'
3026 self.base_url = "https://gcc.gnu.org/onlinedocs/gcc-#{release}/gfortran/"
3127 end
3228 end
lib/docs/scrapers/go.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Go < UrlScraper
33 self.type = 'go'
4− self.release = '1.10.1'
4+ self.release = '1.11.2'
55 self.base_url = 'https://golang.org/pkg/'
66 self.links = {
77 home: 'https://golang.org/',
lib/docs/scrapers/godot.rb+1−1
@@ -29,7 +29,7 @@ module Docs · 28 unmodified lines
2929 end
3030
3131 version '3.0' do
32− self.release = '3.0'
32+ self.release = '3.0.6'
3333 self.base_url = "http://docs.godotengine.org/en/#{self.version}/"
3434 end
3535
lib/docs/scrapers/graphite.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Graphite < UrlScraper
33 self.type = 'graphite'
4− self.release = '1.1.3'
4+ self.release = '1.1.4'
55 self.base_url = 'https://graphite.readthedocs.io/en/latest/'
66 self.links = {
77 code: 'https://github.com/graphite-project/graphite-web'
lib/docs/scrapers/haskell.rb+1−1
@@ -57,7 +57,7 @@ module Docs · 56 unmodified lines
5757 end
5858
5959 version '8' do
60− self.release = '8.2.1'
60+ self.release = '8.6.1'
6161 self.base_url = "https://downloads.haskell.org/~ghc/#{release}/docs/html/"
6262 end
6363
lib/docs/scrapers/homebrew.rb+2−3
@@ -2,7 +2,7 @@ module Docs · 1 unmodified line
22 class Homebrew < UrlScraper
33 self.name = 'Homebrew'
44 self.type = 'simple'
5− self.release = '1.4.2'
5+ self.release = '1.8.1'
66 self.base_url = 'https://docs.brew.sh/'
77 self.links = {
88 home: 'https://brew.sh',
@@ -13,8 +13,7 @@ module Docs · 4 unmodified lines
1313
1414 options[:container] = ->(filter) { filter.root_page? ? '#home' : '#page' }
1515
16− options[:skip_patterns] = [/maintainer/i, /core\-contributor/i]
17− options[:skip] = %w(Kickstarter-Supporters.html)
16+ options[:skip_patterns] = [/maintainer/i, /core\-contributor/i, /kickstarter/i]
1817
1918 options[:attribution] = <<-HTML
2019 &copy; 2009&ndash;present Homebrew contributors<br>
lib/docs/scrapers/jasmine.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Jasmine < UrlScraper
33 self.type = 'simple'
4− self.release = '3.2.1'
4+ self.release = '3.3.0'
55 self.base_url = 'https://jasmine.github.io/api/3.2/'
66 self.root_path = 'index.html'
77 self.links = {
lib/docs/scrapers/julia.rb+2−2
@@ -8,12 +8,12 @@ module Docs · 7 unmodified lines
88 options[:only_patterns] = [/\Amanual\//, /\Astdlib\//]
99
1010 options[:attribution] = <<-HTML
11− &copy; 2009&ndash;2016 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and other contributors<br>
11+ &copy; 2009&ndash;2018 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and other contributors<br>
1212 Licensed under the MIT License.
1313 HTML
1414
1515 version '1.0' do
16− self.release = '1.0.0'
16+ self.release = '1.0.1'
1717 self.base_url = "https://docs.julialang.org/en/v#{release}/"
1818 self.type = 'julia'
1919
lib/docs/scrapers/koa.rb+1−1
@@ -3,7 +3,7 @@ · 2 unmodified lines
33 module Docs
44 class Koa < Github
55 self.base_url = 'https://github.com/koajs/koa/blob/master/docs/'
6− self.release = '2.5.1'
6+ self.release = '2.6.1'
77
88 self.root_path = 'api/index.md'
99 self.initial_paths = %w[
lib/docs/scrapers/leaflet.rb+1−1
@@ -20,7 +20,7 @@ module Docs · 19 unmodified lines
2020 HTML
2121
2222 version '1.3' do
23− self.release = '1.3.0'
23+ self.release = '1.3.4'
2424 self.base_url = "https://leafletjs.com/reference-#{release}.html"
2525 end
2626
lib/docs/scrapers/matplotlib.rb+29−11
@@ -6,7 +6,7 @@ module Docs · 5 unmodified lines
66 self.type = 'sphinx'
77 self.root_path = 'index.html'
88 self.links = {
9− home: 'http://matplotlib.org/',
9+ home: 'https://matplotlib.org/',
1010 code: 'https://github.com/matplotlib/matplotlib'
1111 }
1212
@@ -16,34 +16,52 @@ module Docs · 3 unmodified lines
1616 options[:skip] = %w(api_changes.html tutorial.html faq.html)
1717
1818 options[:attribution] = <<-HTML
19− &copy; 2012&ndash;2017 Matplotlib Development Team. All rights reserved.<br>
19+ &copy; 2012&ndash;2018 Matplotlib Development Team. All rights reserved.<br>
2020 Licensed under the Matplotlib License Agreement.
2121 HTML
2222
23+ version '3.0' do
24+ self.release = '3.0.0'
25+ self.base_urls = [
26+ "https://matplotlib.org/#{release}/api/",
27+ "https://matplotlib.org/#{release}/mpl_toolkits/mplot3d/",
28+ "https://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/"
29+ ]
30+ end
31+
32+ version '2.2' do
33+ self.release = '2.2.3'
34+ self.base_urls = [
35+ "https://matplotlib.org/#{release}/api/",
36+ "https://matplotlib.org/#{release}/mpl_toolkits/mplot3d/",
37+ "https://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/"
38+ ]
39+ end
40+
2341 version '2.1' do
2442 self.release = '2.1.0'
2543 self.base_urls = [
26− "http://matplotlib.org/#{release}/api/",
27− "http://matplotlib.org/#{release}/mpl_toolkits/mplot3d/",
28− "http://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/"
44+ "https://matplotlib.org/#{release}/api/",
45+ "https://matplotlib.org/#{release}/mpl_toolkits/mplot3d/",
46+ "https://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/"
2947 ]
3048 end
3149
3250 version '2.0' do
3351 self.release = '2.0.2'
3452 self.base_urls = [
35− "http://matplotlib.org/#{release}/api/",
36− "http://matplotlib.org/#{release}/mpl_toolkits/mplot3d/",
37− "http://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/"
53+ "https://matplotlib.org/#{release}/api/",
54+ "https://matplotlib.org/#{release}/mpl_toolkits/mplot3d/",
55+ "https://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/"
3856 ]
3957 end
4058
4159 version '1.5' do
4260 self.release = '1.5.3'
4361 self.base_urls = [
44− "http://matplotlib.org/#{release}/api/",
45− "http://matplotlib.org/#{release}/mpl_toolkits/mplot3d/",
46− "http://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/"
62+ "https://matplotlib.org/#{release}/api/",
63+ "https://matplotlib.org/#{release}/mpl_toolkits/mplot3d/",
64+ "https://matplotlib.org/#{release}/mpl_toolkits/axes_grid/api/"
4765 ]
4866 end
4967 end
lib/docs/scrapers/mocha.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Mocha < UrlScraper
33 self.type = 'simple'
4− self.release = '5.0.1'
4+ self.release = '5.2.0'
55 self.base_url = 'https://mochajs.org/'
66 self.links = {
77 home: 'https://mochajs.org/',
lib/docs/scrapers/nginx.rb+1−1
@@ -2,7 +2,7 @@ module Docs · 1 unmodified line
22 class Nginx < UrlScraper
33 self.name = 'nginx'
44 self.type = 'nginx'
5− self.release = '1.15.0'
5+ self.release = '1.15.5'
66 self.base_url = 'https://nginx.org/en/docs/'
77 self.links = {
88 home: 'https://nginx.org/',
lib/docs/scrapers/nim.rb+2−2
@@ -1,7 +1,7 @@
11 module Docs
22 class Nim < UrlScraper
33 self.type = 'simple'
4− self.release = '0.18.0'
4+ self.release = '0.19.0'
55 self.base_url = 'https://nim-lang.org/docs/'
66 self.root_path = 'overview.html'
77 self.links = {
@@ -14,7 +14,7 @@ module Docs · 6 unmodified lines
1414 options[:skip] = %w(theindex.html docgen.txt)
1515
1616 options[:attribution] = <<-HTML
17− &copy; 2006&ndash;2017 Andreas Rumpf<br>
17+ &copy; 2006&ndash;2018 Andreas Rumpf<br>
1818 Licensed under the MIT License.
1919 HTML
2020 end
lib/docs/scrapers/node.rb+7−2
@@ -23,12 +23,17 @@ module Docs · 22 unmodified lines
2323 HTML
2424
2525 version do
26− self.release = '10.9.0'
26+ self.release = '11.1.0'
27+ self.base_url = 'https://nodejs.org/dist/latest-v11.x/docs/api/'
28+ end
29+
30+ version '10 LTS' do
31+ self.release = '10.13.0'
2732 self.base_url = 'https://nodejs.org/dist/latest-v10.x/docs/api/'
2833 end
2934
3035 version '8 LTS' do
31− self.release = '8.11.4'
36+ self.release = '8.12.0'
3237 self.base_url = 'https://nodejs.org/dist/latest-v8.x/docs/api/'
3338 end
3439
lib/docs/scrapers/nokogiri2.rb+8−4
@@ -1,9 +1,13 @@
11 module Docs
22 class Nokogiri2 < Rdoc
3+ # Instructions:
4+ # 1. Download the latest release at https://github.com/sparklemotion/nokogiri/releases
5+ # 2. Run "bundle install && bundle exec rake docs" (in the Nokogiri directory)
6+ # 4. Copy the "doc" directory to "docs/nokgiri"
7+
38 self.name = 'Nokogiri'
49 self.slug = 'nokogiri'
5− self.release = '1.8.1'
6− self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Nokogiri'
10+ self.release = '1.9.0'
711
812 html_filters.replace 'rdoc/entries', 'nokogiri2/entries'
913
@@ -11,8 +15,8 @@ module Docs · 1 unmodified line
1115 options[:only_patterns] = [/\ANokogiri/, /\AXSD/]
1216
1317 options[:attribution] = <<-HTML
14− &copy; 2008&ndash;2017 Aaron Patterson, Mike Dalessio, Charles Nutter, Sergio Arbeo<br>
15− Patrick Mahoney, Yoko Harada, Akinori Musha, John Shahid<br>
18+ &copy; 2008&ndash;2018 Aaron Patterson, Mike Dalessio, Charles Nutter, Sergio Arbeo,<br>
19+ Patrick Mahoney, Yoko Harada, Akinori Musha, John Shahid, Lars Kanis<br>
1620 Licensed under the MIT License.
1721 HTML
1822 end
lib/docs/scrapers/numpy.rb+0−1
@@ -2,7 +2,6 @@ module Docs · 1 unmodified line
22 class Numpy < FileScraper
33 self.name = 'NumPy'
44 self.type = 'sphinx'
5− self.dir = '/Users/Thibaut/DevDocs/Docs/numpy/reference/'
65 self.root_path = 'index.html'
76 self.links = {
87 home: 'http://www.numpy.org/',
lib/docs/scrapers/openjdk.rb+2−3
@@ -1,11 +1,10 @@
11 module Docs
22 class Openjdk < FileScraper
3+ # Downloaded from packages.debian.org/sid/openjdk-8-doc
4+ # Extracting subdirectory /usr/share/doc/openjdk-8-jre-headless/api
35 self.name = 'OpenJDK'
46 self.type = 'openjdk'
57 self.root_path = 'overview-summary.html'
6− # Downloaded from packages.debian.org/sid/openjdk-8-doc
7− # Extracting subdirectory /usr/share/doc/openjdk-8-jre-headless/api
8− self.dir = '/Users/Thibaut/DevDocs/Docs/OpenJDK'
98
109 html_filters.insert_after 'internal_urls', 'openjdk/clean_urls'
1110 html_filters.push 'openjdk/entries', 'openjdk/clean_html'
lib/docs/scrapers/pandas.rb+5−0
@@ -20,6 +20,11 @@ module Docs · 19 unmodified lines
2020 Licensed under the 3-clause BSD License.
2121 HTML
2222
23+ version '0.23' do
24+ self.release = '0.23.4'
25+ self.base_url = "http://pandas.pydata.org/pandas-docs/version/#{self.release}/"
26+ end
27+
2328 version '0.22' do
2429 self.release = '0.22.0'
2530 self.base_url = "http://pandas.pydata.org/pandas-docs/version/#{self.release}/"
lib/docs/scrapers/perl.rb+0−1
@@ -2,7 +2,6 @@ module Docs · 1 unmodified line
22 class Perl < FileScraper
33 self.name = 'Perl'
44 self.type = 'perl'
5− self.dir = '/Users/Thibaut/DevDocs/Docs/Perl'
65 self.root_path = 'index.html'
76 self.links = {
87 home: 'https://www.perl.org/'
lib/docs/scrapers/phoenix.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Phoenix < UrlScraper
33 self.type = 'elixir'
4− self.release = '1.3.2'
4+ self.release = '1.3.4'
55 self.base_url = 'https://hexdocs.pm/'
66 self.root_path = 'phoenix/Phoenix.html'
77 self.initial_paths = %w(
lib/docs/scrapers/php.rb+2−3
@@ -1,5 +1,7 @@
11 module Docs
22 class Php < FileScraper
3+ # Downloaded from php.net/download-docs.php
4+
35 include FixInternalUrlsBehavior
46
57 self.name = 'PHP'
@@ -23,9 +25,6 @@ module Docs · 17 unmodified lines
2325 code: 'https://git.php.net/?p=php-src.git;a=summary'
2426 }
2527
26− # Downloaded from php.net/download-docs.php
27− self.dir = '/Users/Thibaut/DevDocs/Docs/PHP'
28−
2928 html_filters.push 'php/internal_urls', 'php/entries', 'php/clean_html', 'title'
3029 text_filters.push 'php/fix_urls'
3130
lib/docs/scrapers/puppeteer.rb+1−1
@@ -1,6 +1,6 @@
11 module Docs
22 class Puppeteer < Github
3− self.release = '1.8.0'
3+ self.release = '1.10.0'
44 self.base_url = 'https://github.com/GoogleChrome/puppeteer/blob/v1.8.0/docs/api.md'
55 self.links = {
66 code: 'https://github.com/GoogleChrome/puppeteer'
lib/docs/scrapers/python.rb+4−8
@@ -23,33 +23,29 @@ module Docs · 22 unmodified lines
2323 Licensed under the PSF License.
2424 HTML
2525
26− version '3.7' do
26+ version '3.7' do # docs.python.org/3.7/download.html
2727 self.release = '3.7.0'
28− self.dir = '/Users/Thibaut/DevDocs/Docs/Python37' # docs.python.org/3.7/download.html
2928 self.base_url = 'https://docs.python.org/3.7/'
3029
3130 html_filters.push 'python/entries_v3', 'sphinx/clean_html', 'python/clean_html'
3231 end
3332
34− version '3.6' do
33+ version '3.6' do # docs.python.org/3.6/download.html
3534 self.release = '3.6.6'
36− self.dir = '/Users/Thibaut/DevDocs/Docs/Python36' # docs.python.org/3.6/download.html
3735 self.base_url = 'https://docs.python.org/3.6/'
3836
3937 html_filters.push 'python/entries_v3', 'sphinx/clean_html', 'python/clean_html'
4038 end
4139
42− version '3.5' do
40+ version '3.5' do # docs.python.org/3.5/download.html
4341 self.release = '3.5.3'
44− self.dir = '/Users/Thibaut/DevDocs/Docs/Python35' # docs.python.org/3.5/download.html
4542 self.base_url = 'https://docs.python.org/3.5/'
4643
4744 html_filters.push 'python/entries_v3', 'sphinx/clean_html', 'python/clean_html'
4845 end
4946
50− version '2.7' do
47+ version '2.7' do # docs.python.org/2.7/download.html
5148 self.release = '2.7.13'
52− self.dir = '/Users/Thibaut/DevDocs/Docs/Python27' # docs.python.org/2.7/download.html
5349 self.base_url = 'https://docs.python.org/2.7/'
5450
5551 html_filters.push 'python/entries_v2', 'sphinx/clean_html', 'python/clean_html'
lib/docs/scrapers/rdoc/minitest.rb+7−2
@@ -1,9 +1,14 @@
11 module Docs
22 class Minitest < Rdoc
3+ # Instructions:
4+ # 1. Run "gem update rdoc hoe"
5+ # 2. Download the source code at https://github.com/seattlerb/minitest
6+ # 3. Run "rake docs" (in the Minitest directory)
7+ # 4. Copy the "docs" directory to "docs/minitest"
8+
39 self.name = 'Ruby / Minitest'
410 self.slug = 'minitest'
5− self.release = '5.10.3'
6− self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Minitest' # rake docs
11+ self.release = '5.11.3'
712 self.links = {
813 code: 'https://github.com/seattlerb/minitest'
914 }
lib/docs/scrapers/rdoc/rails.rb+10−3
@@ -1,10 +1,17 @@
11 module Docs
22 class Rails < Rdoc
3+ # Instructions:
4+ # 1. Download a release at https://github.com/rails/rails/releases
5+ # 2. Open "railties/lib/rails/api/task.rb" and comment out any code related to sdoc ("configure_sdoc")
6+ # 3. Run "bundle install --without db && bundle exec rake rdoc" (in the Rails directory)
7+ # 4. Run "cd guides && bundle exec rake guides:generate:html"
8+ # 5. Copy the "guides/output" directory to "html/guides"
9+ # 6. Copy the "html" directory to "docs/rails~[version]"
10+
311 include FixInternalUrlsBehavior
412
513 self.name = 'Ruby on Rails'
614 self.slug = 'rails'
7− self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Rails'
815 self.initial_paths = %w(guides/index.html)
916 self.links = {
1017 home: 'http://rubyonrails.org/',
@@ -68,7 +75,7 @@ module Docs · 57 unmodified lines
6875 end
6976
7077 version '5.2' do
71− self.release = '5.2.0'
78+ self.release = '5.2.2'
7279 end
7380
7481 version '5.1' do
@@ -80,7 +87,7 @@ module Docs · 5 unmodified lines
8087 end
8188
8289 version '4.2' do
83− self.release = '4.2.10'
90+ self.release = '4.2.11'
8491 end
8592
8693 version '4.1' do
lib/docs/scrapers/rdoc/ruby.rb+8−19
@@ -1,16 +1,9 @@
11 module Docs
22 class Ruby < Rdoc
3− # Generated with:
4− # ./configure && make html
5− # or:
6− # rdoc \
7− # --root . \
8− # --page-dir doc \
9− # --encoding=UTF-8 \
10− # --visibility=public \
11− # --format=darkfish \
12− # --no-line-numbers \
13− # --op html .
3+ # Instructions:
4+ # 1. Download Ruby's source code
5+ # 2. Run "./configure && make html" (in the Ruby directory)
6+ # 3. Copy the ".ext/html" directory to "docs/ruby~[version]"
147
158 include FixInternalUrlsBehavior
169
@@ -77,23 +70,19 @@ module Docs · 60 unmodified lines
7770 HTML
7871
7972 version '2.5' do
80− self.release = '2.5.0'
81− self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Ruby25'
73+ self.release = '2.5.3'
8274 end
8375
8476 version '2.4' do
85− self.release = '2.4.3'
86− self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Ruby24'
77+ self.release = '2.4.5'
8778 end
8879
8980 version '2.3' do
90− self.release = '2.3.6'
91− self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Ruby23'
81+ self.release = '2.3.8'
9282 end
9383
9484 version '2.2' do
95− self.release = '2.2.9'
96− self.dir = '/Users/Thibaut/DevDocs/Docs/RDoc/Ruby22'
85+ self.release = '2.2.10'
9786 end
9887 end
9988 end
lib/docs/scrapers/react.rb+1−1
@@ -2,7 +2,7 @@ module Docs · 1 unmodified line
22 class React < UrlScraper
33 self.name = 'React'
44 self.type = 'simple'
5− self.release = '16.4.0'
5+ self.release = '16.6.0'
66 self.base_url = 'https://reactjs.org/docs/'
77 self.root_path = 'hello-world.html'
88 self.links = {
lib/docs/scrapers/redis.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Redis < UrlScraper
33 self.type = 'redis'
4− self.release = '4.0.11'
4+ self.release = '5.0.0'
55 self.base_url = 'https://redis.io/commands'
66 self.links = {
77 home: 'https://redis.io/',
lib/docs/scrapers/rust.rb+4−1
@@ -1,7 +1,9 @@
1+# frozen_string_literal: true
2+
13 module Docs
24 class Rust < UrlScraper
35 self.type = 'rust'
4− self.release = '1.29.1'
6+ self.release = '1.30.1'
57 self.base_url = 'https://doc.rust-lang.org/'
68 self.root_path = 'book/second-edition/index.html'
79 self.initial_paths = %w(
@@ -28,6 +30,7 @@ module Docs · 20 unmodified lines
2830 options[:fix_urls] = ->(url) do
2931 url.sub! %r{(#{Rust.base_url}.+/)\z}, '\1index.html'
3032 url.sub! '/unicode/u_str', '/unicode/str/'
33+ url.sub! '/std/std/', '/std/'
3134 url
3235 end
3336
lib/docs/scrapers/scikit_image.rb+2−2
@@ -3,8 +3,8 @@ module Docs · 2 unmodified lines
33 self.name = 'scikit-image'
44 self.slug = 'scikit_image'
55 self.type = 'sphinx'
6− self.release = '0.13.1'
7− self.base_url = 'http://scikit-image.org/docs/0.13.x/'
6+ self.release = '0.14.1'
7+ self.base_url = 'http://scikit-image.org/docs/0.14.x/'
88 self.links = {
99 home: 'http://scikit-image.org/',
1010 code: 'https://github.com/scikit-image/scikit-image'
lib/docs/scrapers/scikit_learn.rb+2−2
@@ -3,7 +3,7 @@ module Docs · 2 unmodified lines
33 self.name = 'scikit-learn'
44 self.slug = 'scikit_learn'
55 self.type = 'sphinx'
6− self.release = '0.19.1'
6+ self.release = '0.20.0'
77 self.base_url = 'http://scikit-learn.org/stable/'
88 self.root_path = 'documentation.html'
99 self.force_gzip = true
@@ -21,7 +21,7 @@ module Docs · 11 unmodified lines
2121 options[:max_image_size] = 256_000
2222
2323 options[:attribution] = <<-HTML
24− &copy; 2007&ndash;2017 The scikit-learn developers<br>
24+ &copy; 2007&ndash;2018 The scikit-learn developers<br>
2525 Licensed under the 3-clause BSD License.
2626 HTML
2727
lib/docs/scrapers/sinon.rb+13−8
@@ -4,7 +4,7 @@ module Docs · 3 unmodified lines
44 self.slug = 'sinon'
55 self.type = 'sinon'
66 self.links = {
7− home: 'http://sinonjs.org/',
7+ home: 'https://sinonjs.org/',
88 code: 'https://github.com/sinonjs/sinon'
99 }
1010
@@ -18,34 +18,39 @@ module Docs · 7 unmodified lines
1818 Licensed under the BSD License.
1919 HTML
2020
21+ version '7' do
22+ self.release = '7.1.1'
23+ self.base_url = "https://sinonjs.org/releases/v#{release}/"
24+ end
25+
2126 version '6' do
22− self.release = '6.1.3'
23− self.base_url = "http://sinonjs.org/releases/v#{release}/"
27+ self.release = '6.3.5'
28+ self.base_url = "https://sinonjs.org/releases/v#{release}/"
2429 end
2530
2631 version '5' do
2732 self.release = '5.1.0'
28− self.base_url = "http://sinonjs.org/releases/v#{release}/"
33+ self.base_url = "https://sinonjs.org/releases/v#{release}/"
2934 end
3035
3136 version '4' do
3237 self.release = '4.5.0'
33− self.base_url = "http://sinonjs.org/releases/v#{release}/"
38+ self.base_url = "https://sinonjs.org/releases/v#{release}/"
3439 end
3540
3641 version '3' do
3742 self.release = '3.3.0'
38− self.base_url = "http://sinonjs.org/releases/v#{release}/"
43+ self.base_url = "https://sinonjs.org/releases/v#{release}/"
3944 end
4045
4146 version '2' do
4247 self.release = '2.4.1'
43− self.base_url = "http://sinonjs.org/releases/v#{release}/"
48+ self.base_url = "https://sinonjs.org/releases/v#{release}/"
4449 end
4550
4651 version '1' do
4752 self.release = '1.17.7'
48− self.base_url = "http://sinonjs.org/releases/v#{release}/"
53+ self.base_url = "https://sinonjs.org/releases/v#{release}/"
4954 end
5055 end
5156 end
lib/docs/scrapers/sqlite.rb+1−2
@@ -2,8 +2,7 @@ module Docs · 1 unmodified line
22 class Sqlite < FileScraper
33 self.name = 'SQLite'
44 self.type = 'sqlite'
5− self.release = '3.23.1'
6− self.dir = '/Users/Thibaut/DevDocs/Docs/sqlite/'
5+ self.release = '3.25.2'
76 self.base_url = 'https://sqlite.org/'
87 self.root_path = 'docs.html'
98 self.initial_paths = %w(keyword_index.html)
lib/docs/scrapers/statsmodels.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Statsmodels < UrlScraper
33 self.type = 'sphinx'
4− self.release = '0.8.0'
4+ self.release = '0.9.0'
55 self.base_url = 'http://www.statsmodels.org/stable/'
66 self.root_path = 'index.html'
77 self.links = {
lib/docs/scrapers/symfony.rb+13−8
@@ -26,44 +26,49 @@ module Docs · 25 unmodified lines
2626 Licensed under the MIT License.
2727 HTML
2828
29+ version '4.1' do
30+ self.release = '4.1.7'
31+ self.base_url = "https://api.symfony.com/#{version}/"
32+ end
33+
2934 version '4.0' do
3035 self.release = '4.0.3'
31− self.base_url = "http://api.symfony.com/#{version}/"
36+ self.base_url = "https://api.symfony.com/#{version}/"
3237 end
3338
3439 version '3.4' do
3540 self.release = '3.4.3'
36− self.base_url = "http://api.symfony.com/#{version}/"
41+ self.base_url = "https://api.symfony.com/#{version}/"
3742 end
3843
3944 version '3.3' do
4045 self.release = '3.3.15'
41− self.base_url = "http://api.symfony.com/#{version}/"
46+ self.base_url = "https://api.symfony.com/#{version}/"
4247 end
4348
4449 version '3.2' do
4550 self.release = '3.2.13'
46− self.base_url = "http://api.symfony.com/#{version}/"
51+ self.base_url = "https://api.symfony.com/#{version}/"
4752 end
4853
4954 version '3.1' do
5055 self.release = '3.1.8'
51− self.base_url = "http://api.symfony.com/#{version}/"
56+ self.base_url = "https://api.symfony.com/#{version}/"
5257 end
5358
5459 version '3.0' do
5560 self.release = '3.0.1'
56− self.base_url = "http://api.symfony.com/#{version}/"
61+ self.base_url = "https://api.symfony.com/#{version}/"
5762 end
5863
5964 version '2.8' do
6065 self.release = '2.8.28'
61− self.base_url = "http://api.symfony.com/#{version}/"
66+ self.base_url = "https://api.symfony.com/#{version}/"
6267 end
6368
6469 version '2.7' do
6570 self.release = '2.7.35'
66− self.base_url = "http://api.symfony.com/#{version}/"
71+ self.base_url = "https://api.symfony.com/#{version}/"
6772 end
6873 end
6974 end
lib/docs/scrapers/twig.rb+6−6
@@ -4,14 +4,14 @@ module Docs · 3 unmodified lines
44 self.root_path = 'index.html'
55 self.initial_paths = %w(extensions/index.html)
66 self.links = {
7− home: 'https://twig.sensiolabs.org/',
7+ home: 'https://twig.symfony.com/',
88 code: 'https://github.com/twigphp/Twig'
99 }
1010
1111 options[:attribution] = <<-HTML
12− &copy; 2009&ndash;2017 by the Twig Team<br>
12+ &copy; 2009&ndash;2018 by the Twig Team<br>
1313 Licensed under the three clause BSD license.<br>
14− The Twig logo is &copy; 2010&ndash;2017 SensioLabs
14+ The Twig logo is &copy; 2010&ndash;2018 Symfony
1515 HTML
1616
1717 html_filters.push 'twig/clean_html', 'twig/entries'
@@ -20,13 +20,13 @@ module Docs · 2 unmodified lines
2020 options[:skip] = %w(deprecated.html advanced_legacy.html)
2121
2222 version '2' do
23− self.release = '2.4.3'
24− self.base_url = 'https://twig.sensiolabs.org/doc/2.x/'
23+ self.release = '2.5.0'
24+ self.base_url = 'https://twig.symfony.com/doc/2.x/'
2525 end
2626
2727 version '1' do
2828 self.release = '1.34.3'
29− self.base_url = 'https://twig.sensiolabs.org/doc/1.x/'
29+ self.base_url = 'https://twig.symfony.com/doc/1.x/'
3030 end
3131 end
3232 end
lib/docs/scrapers/typescript.rb+1−1
@@ -2,7 +2,7 @@ module Docs · 1 unmodified line
22 class Typescript < UrlScraper
33 self.name = 'TypeScript'
44 self.type = 'simple'
5− self.release = '3.0.1'
5+ self.release = '3.1.6'
66 self.base_url = 'https://www.typescriptlang.org/docs/'
77 self.root_path = 'tutorial.html'
88 self.links = {
lib/docs/scrapers/underscore.rb+4−4
@@ -3,10 +3,10 @@ module Docs · 2 unmodified lines
33 self.name = 'Underscore.js'
44 self.slug = 'underscore'
55 self.type = 'underscore'
6− self.release = '1.9.0'
7− self.base_url = 'http://underscorejs.org'
6+ self.release = '1.9.1'
7+ self.base_url = 'https://underscorejs.org'
88 self.links = {
9− home: 'http://underscorejs.org',
9+ home: 'https://underscorejs.org',
1010 code: 'https://github.com/jashkenas/underscore'
1111 }
1212
@@ -17,7 +17,7 @@ module Docs · 4 unmodified lines
1717 options[:skip_links] = true
1818
1919 options[:attribution] = <<-HTML
20− &copy; 2009&ndash;2017 Jeremy Ashkenas, DocumentCloud and Investigative Reporters &amp; Editors<br>
20+ &copy; 2009&ndash;2018 Jeremy Ashkenas, DocumentCloud and Investigative Reporters &amp; Editors<br>
2121 Licensed under the MIT License.
2222 HTML
2323 end
lib/docs/scrapers/vagrant.rb+1−1
@@ -2,7 +2,7 @@ module Docs · 1 unmodified line
22 class Vagrant < UrlScraper
33 self.name = 'Vagrant'
44 self.type = 'simple'
5− self.release = '2.1.1'
5+ self.release = '2.2.0'
66 self.base_url = 'https://www.vagrantup.com/docs/'
77 self.root_path = 'index.html'
88 self.links = {
lib/docs/scrapers/yarn.rb+1−1
@@ -1,7 +1,7 @@
11 module Docs
22 class Yarn < UrlScraper
33 self.type = 'simple'
4− self.release = '1.9.4'
4+ self.release = '1.12.1'
55 self.base_url = 'https://yarnpkg.com/en/docs/'
66 self.links = {
77 home: 'https://yarnpkg.com/',
lib/docs/subscribers/requester_subscriber.rb+13−0
@@ -0,0 +1,13 @@
1+# frozen_string_literal: true
2+
3+module Docs
4+ class RequesterSubscriber < Subscriber
5+ self.namespace = 'requester'
6+
7+ def handle_response(event)
8+ if event.duration > 10_000
9+ log "WARN: #{format_url event.payload[:url]} was slow to process (#{(event.duration / 1000).round}s)"
10+ end
11+ end
12+ end
13+end
lib/tasks/docs.thor+111−13
@@ -12,15 +12,29 @@ class DocsCLI < Thor · 11 unmodified lines
1212 end
1313
1414 desc 'list', 'List available documentations'
15+ option :packaged, type: :boolean
1516 def list
16− output = Docs.all.flat_map do |doc|
17− name = doc.to_s.demodulize.underscore
18− if doc.versioned?
19− doc.versions.map { |_doc| "#{name}@#{_doc.version}" }
20− else
21− name
17+ if options[:packaged]
18+ slugs = Dir[File.join(Docs.store_path, '*.tar.gz')].map { |f| File.basename(f, '.tar.gz') }
19+ names = find_docs_by_slugs(slugs).map do |doc|
20+ name = if doc.version?
21+ "#{doc.superclass.to_s.demodulize.underscore}@#{doc.version}"
22+ else
23+ doc.to_s.demodulize.underscore
24+ end
25+ end
26+ else
27+ names = Docs.all.flat_map do |doc|
28+ name = doc.to_s.demodulize.underscore
29+ if doc.versioned?
30+ doc.versions.map { |_doc| "#{name}@#{_doc.version}" }
31+ else
32+ name
33+ end
2234 end
23− end.join("\n")
35+ end
36+
37+ output = names.join("\n")
2438
2539 require 'tty-pager'
2640 TTY::Pager.new.page(output)
@@ -39,7 +53,7 @@ class DocsCLI < Thor · 12 unmodified lines
3953 Docs.install_report :store if options[:verbose]
4054 if options[:debug]
4155 GC.disable
42− Docs.install_report :filter, :request
56+ Docs.install_report :filter, :request, :doc
4357 end
4458
4559 if Docs.generate_page(name, options[:version], path)
@@ -62,7 +76,7 @@ class DocsCLI < Thor · 16 unmodified lines
6276 Docs.rescue_errors = true
6377 Docs.install_report :store if options[:verbose]
6478 Docs.install_report :scraper if options[:debug]
65− Docs.install_report :progress_bar, :doc, :image if $stdout.tty?
79+ Docs.install_report :progress_bar, :doc, :image, :requester if $stdout.tty?
6680
6781 require 'unix_utils' if options[:package]
6882
@@ -149,15 +163,55 @@ class DocsCLI < Thor · 80 unmodified lines
149163 option :dryrun, type: :boolean
150164 option :packaged, type: :boolean
151165 def upload(*names)
152− names = Dir[File.join(Docs.store_path, '*.tar.gz')].map { |f| File.basename(f, '.tar.gz') } if options[:packaged]
153− docs = find_docs(names)
166+ require 'net/sftp'
167+
168+ if options[:packaged]
169+ slugs = Dir[File.join(Docs.store_path, '*.tar.gz')].map { |f| File.basename(f, '.tar.gz') }
170+ docs = find_docs_by_slugs(slugs)
171+ else
172+ docs = find_docs(names)
173+ end
174+
154175 assert_docs(docs)
176+
177+ # Verify files are present
155178 docs.each do |doc|
156− puts "Syncing #{doc.path}..."
157− cmd = "aws s3 sync #{File.join(Docs.store_path, doc.path)} s3://docs.devdocs.io/#{doc.path} --delete"
179+ unless Dir.exists?(File.join(Docs.store_path, doc.path))
180+ puts "ERROR: directory #{File.join(Docs.store_path, doc.path)} not found."
181+ return
182+ end
183+
184+ unless File.exists?(File.join(Docs.store_path, "#{doc.path}.tar.gz"))
185+ puts "ERROR: package for '#{doc.slug}' documentation not found. Run 'thor docs:package #{doc.slug}' to create it."
186+ return
187+ end
188+ end
189+
190+ # Sync files with S3 (used by the web app)
191+ puts '[S3] Begin syncing.'
192+ docs.each do |doc|
193+ puts "[S3] Syncing #{doc.path}..."
194+ cmd = "aws s3 sync #{File.join(Docs.store_path, doc.path)} s3://devdocs-assets/#{doc.path} --delete --profile devdocs"
158195 cmd << ' --dryrun' if options[:dryrun]
159196 system(cmd)
160197 end
198+ puts '[S3] Done syncing.'
199+
200+ # Upload packages to dl.devdocs.io (used by the "thor docs:download" command)
201+ puts '[MaxCDN] Begin uploading.'
202+ Net::SFTP.start('ftp.devdocs-dl.devdocs.netdna-cdn.com', ENV['DEVDOCS_DL_USERNAME'], password: ENV['DEVDOCS_DL_PASSWORD']) do |sftp|
203+ docs.each do |doc|
204+ filename = "#{doc.path}.tar.gz"
205+ print "[MaxCDN] Uploading #{filename}..."
206+ if options[:dryrun]
207+ print "\n"
208+ else
209+ sftp.upload! File.join(Docs.store_path, filename), File.join('', 'public_html', filename)
210+ print " OK\n"
211+ end
212+ end
213+ end
214+ puts '[MaxCDN] Done uploading.'
161215 end
162216
163217 desc 'commit', '[private]'
@@ -172,6 +226,43 @@ class DocsCLI < Thor · 8 unmodified lines
172226 handle_doc_not_found_error(error)
173227 end
174228
229+ desc 'prepare_deploy', 'Internal task executed before deployment'
230+ def prepare_deploy
231+ puts 'Docs -- BEGIN'
232+
233+ require 'open-uri'
234+ require 'thread'
235+
236+ docs = Docs.all_versions
237+ time = Time.now.to_i
238+ mutex = Mutex.new
239+
240+ (1..6).map do
241+ Thread.new do
242+ while doc = docs.shift
243+ dir = File.join(Docs.store_path, doc.path)
244+ FileUtils.mkpath(dir)
245+
246+ ['index.json', 'meta.json'].each do |filename|
247+ open("https://docs.devdocs.io/#{doc.path}/#{filename}?#{time}") do |file|
248+ mutex.synchronize do
249+ path = File.join(dir, filename)
250+ File.write(path, file.read)
251+ end
252+ end
253+ end
254+
255+ puts "Docs -- Downloaded #{doc.slug}"
256+ end
257+ end
258+ end.map(&:join)
259+
260+ puts 'Docs -- Generating manifest...'
261+ generate_manifest
262+
263+ puts 'Docs -- DONE'
264+ end
265+
175266 private
176267
177268 def find_docs(names)
@@ -185,6 +276,13 @@ class DocsCLI < Thor · 7 unmodified lines
185276 end
186277 end
187278
279+ def find_docs_by_slugs(slugs)
280+ slugs.flat_map do |slug|
281+ slug, version = slug.split(/~/)
282+ Docs.find_by_slug(slug, version)
283+ end
284+ end
285+
188286 def assert_docs(docs)
189287 if docs.empty?
190288 puts 'ERROR: called with no arguments.'
public/favicon.pxm+0−0

Binary file not shown.

public/favicon@2x.pxm+0−0

Binary file not shown.

public/icons/docs/css/CSS3.sketch/Data+0−0

Binary file not shown.

public/icons/docs/css/CSS3.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/css/CSS3.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/css/CSS3.sketch/fonts+0−0

Empty file added.

public/icons/docs/css/CSS3.sketch/version+1−0
@@ -0,0 +1 @@
1+10
public/icons/docs/dom/DOM.sketch/Data+0−0

Binary file not shown.

public/icons/docs/dom/DOM.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/dom/DOM.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/dom/DOM.sketch/fonts+0−0

Empty file added.

public/icons/docs/dom/DOM.sketch/version+1−0
@@ -0,0 +1 @@
1+10
public/icons/docs/dom_events/DOM_events.sketch/Data+0−0

Binary file not shown.

public/icons/docs/dom_events/DOM_events.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/dom_events/DOM_events.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/dom_events/DOM_events.sketch/fonts+0−0

Empty file added.

public/icons/docs/dom_events/DOM_events.sketch/version+1−0
@@ -0,0 +1 @@
1+10
public/icons/docs/express/16.pxm+0−0

Binary file not shown.

public/icons/docs/express/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/html/HTML5.sketch/Data+0−0

Binary file not shown.

public/icons/docs/html/HTML5.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/html/HTML5.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/html/HTML5.sketch/fonts+0−0

Empty file added.

public/icons/docs/html/HTML5.sketch/version+1−0
@@ -0,0 +1 @@
1+10
public/icons/docs/http/16.pxm+0−0

Binary file not shown.

public/icons/docs/http/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/javascript/16.pxm+0−0

Binary file not shown.

public/icons/docs/javascript/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/knockout/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/less/less.pxm+0−0

Binary file not shown.

public/icons/docs/moment/moment.sketch/Data+0−0

Binary file not shown.

public/icons/docs/moment/moment.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/moment/moment.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/moment/moment.sketch/fonts+0−0

Empty file added.

public/icons/docs/moment/moment.sketch/metadata+14−0
@@ -0,0 +1,14 @@
1+<?xml version="1.0" encoding="UTF-8"?>
2+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3+<plist version="1.0">
4+<dict>
5+ <key>app</key>
6+ <string>com.bohemiancoding.sketch</string>
7+ <key>build</key>
8+ <integer>5302</integer>
9+ <key>commit</key>
10+ <string>9460a4bc62af5e9ba50dd4143578fd9401710ce5</string>
11+ <key>version</key>
12+ <integer>18</integer>
13+</dict>
14+</plist>
public/icons/docs/moment/moment.sketch/version+1−0
@@ -0,0 +1 @@
1+18
public/icons/docs/nokogiri/icon.pxm+0−0

Binary file not shown.

public/icons/docs/php/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/rails/rails.pxm+0−0

Binary file not shown.

public/icons/docs/sass/sass.pxm+0−0

Binary file not shown.

public/icons/docs/support_tables/16.pxm+0−0

Binary file not shown.

public/icons/docs/support_tables/16@2x.pxm+0−0

Binary file not shown.

public/icons/docs/xpath/XPath.sketch/Data+0−0

Binary file not shown.

public/icons/docs/xpath/XPath.sketch/QuickLook/Preview.png+0−0

Binary file not shown.

public/icons/docs/xpath/XPath.sketch/QuickLook/Thumbnail.png+0−0

Binary file not shown.

public/icons/docs/xpath/XPath.sketch/metadata+18−0
@@ -0,0 +1,18 @@
1+<?xml version="1.0" encoding="UTF-8"?>
2+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3+<plist version="1.0">
4+<dict>
5+ <key>app</key>
6+ <string>com.bohemiancoding.sketch</string>
7+ <key>build</key>
8+ <integer>5355</integer>
9+ <key>commit</key>
10+ <string>b7d299b0a34651d1a0e066786b75aa36168d5809</string>
11+ <key>fonts</key>
12+ <array/>
13+ <key>length</key>
14+ <integer>22373</integer>
15+ <key>version</key>
16+ <integer>18</integer>
17+</dict>
18+</plist>
public/icons/docs/xpath/XPath.sketch/version+1−0
@@ -0,0 +1 @@
1+18
public/images/apple-icon.pxm+0−0

Binary file not shown.

public/images/fluid-icon.pxm+0−0

Binary file not shown.

public/images/icon.pxm+0−0

Binary file not shown.

public/images/webapp-icon-small.pxm+0−0

Binary file not shown.

test/app_test.rb+5−0
@@ -21,6 +21,11 @@ class AppTest < MiniTest::Spec · 20 unmodified lines
2121 assert_equal 'https://example.com/test?q=1', last_response['Location']
2222 end
2323
24+ it 'returns HSTS header' do
25+ get 'https://example.com/test'
26+ assert_equal 'max-age=31536000; includeSubDomains', last_response['Strict-Transport-Security']
27+ end
28+
2429 describe "/" do
2530 it "works" do
2631 get '/'
test/lib/docs/core/scrapers/file_scraper_test.rb+89−47
@@ -2,16 +2,23 @@ require 'test_helper' · 1 unmodified line
22 require 'docs'
33
44 class FileScraperTest < MiniTest::Spec
5+ ROOT_PATH = File.expand_path('../../../../../../', __FILE__)
6+
57 class Scraper < Docs::FileScraper
6− self.dir = '/'
78 self.html_filters = Docs::FilterStack.new
89 self.text_filters = Docs::FilterStack.new
10+
11+ version 'version' do; end
912 end
1013
1114 let :scraper do
1215 Scraper.new
1316 end
1417
18+ let :versioned_scraper do
19+ Scraper.versions.first.new
20+ end
21+
1522 let :response do
1623 OpenStruct.new body: 'body', url: Docs::URL.parse(Scraper.base_url)
1724 end
@@ -22,9 +29,16 @@ class FileScraperTest < MiniTest::Spec · 4 unmodified lines
2229 end
2330 end
2431
32+ describe "#source_directory" do
33+ it "returns the directory at docs/[slug]" do
34+ assert_equal File.join(ROOT_PATH, 'docs', 'scraper'), scraper.source_directory
35+ assert_equal File.join(ROOT_PATH, 'docs', 'scraper~version'), versioned_scraper.source_directory
36+ end
37+ end
38+
2539 describe "#request_one" do
2640 let :path do
27− File.join(Scraper.dir, 'path')
41+ 'path'
2842 end
2943
3044 let :result do
@@ -35,20 +49,34 @@ class FileScraperTest < MiniTest::Spec · 4 unmodified lines
3549 stub(scraper).read_file
3650 end
3751
38− it "reads a file" do
39− mock(scraper).read_file(path)
40− result
52+ context "when the source directory doesn't exist" do
53+ it "raises an error" do
54+ assert_raises Docs::SetupError do
55+ result
56+ end
57+ end
4158 end
4259
43− describe "the returned response object" do
44− it "has a #body" do
45− stub(scraper).read_file { 'body' }
46− assert_equal 'body', result.body
60+ context "when the source directory exists" do
61+ before do
62+ stub(scraper).assert_source_directory_exists
63+ end
64+
65+ it "reads a file" do
66+ mock(scraper).read_file(path)
67+ result
4768 end
4869
49− it "has a #url" do
50− assert_equal path, result.url.to_s
51− assert_instance_of Docs::URL, result.url
70+ describe "the returned response object" do
71+ it "has a #body" do
72+ stub(scraper).read_file { 'body' }
73+ assert_equal 'body', result.body
74+ end
75+
76+ it "has a #url" do
77+ assert_equal path, result.url.to_s
78+ assert_instance_of Docs::URL, result.url
79+ end
5280 end
5381 end
5482 end
@@ -58,49 +86,63 @@ class FileScraperTest < MiniTest::Spec · 3 unmodified lines
5886 %w(one two)
5987 end
6088
61− it "requests the given url" do
62− mock(scraper).request_one('url')
63− scraper.send(:request_all, 'url') {}
64− end
65−
66− it "requests the given urls" do
67− requests = []
68− stub(scraper).request_one { |url| requests << url; nil }
69− scraper.send(:request_all, urls) {}
70− assert_equal urls, requests
71− end
72−
73− it "yields the responses" do
74− responses = []
75− stub(scraper).request_one { |url| urls.index(url) }
76− scraper.send(:request_all, urls) { |response| responses << response; nil }
77− assert_equal (0...urls.length).to_a, responses
89+ context "when the source directory doesn't exist" do
90+ it "raises an error" do
91+ assert_raises Docs::SetupError do
92+ scraper.send(:request_all, urls) {}
93+ end
94+ end
7895 end
7996
80− context "when the block returns an array" do
81− let :next_urls do
82− %w(three four)
97+ context "when the source directory exists" do
98+ before do
99+ stub(scraper).assert_source_directory_exists
83100 end
84101
85− let :all_urls do
86− urls + %w(three four)
102+ it "requests the given url" do
103+ mock(scraper).request_one('url')
104+ scraper.send(:request_all, 'url') {}
87105 end
88106
89− it "requests the returned urls" do
107+ it "requests the given urls" do
90108 requests = []
91− stub(scraper).request_one { |url| requests << url; url }
92− scraper.send(:request_all, urls) { [next_urls.shift].compact }
93− assert_equal all_urls, requests
109+ stub(scraper).request_one { |url| requests << url; nil }
110+ scraper.send(:request_all, urls) {}
111+ assert_equal urls, requests
94112 end
95113
96− it "yields their responses" do
114+ it "yields the responses" do
97115 responses = []
98− stub(scraper).request_one { |url| all_urls.index(url) }
99− scraper.send :request_all, urls do |response|
100− responses << response
101− [next_urls.shift].compact
116+ stub(scraper).request_one { |url| urls.index(url) }
117+ scraper.send(:request_all, urls) { |response| responses << response; nil }
118+ assert_equal (0...urls.length).to_a, responses
119+ end
120+
121+ context "when the block returns an array" do
122+ let :next_urls do
123+ %w(three four)
124+ end
125+
126+ let :all_urls do
127+ urls + %w(three four)
128+ end
129+
130+ it "requests the returned urls" do
131+ requests = []
132+ stub(scraper).request_one { |url| requests << url; url }
133+ scraper.send(:request_all, urls) { [next_urls.shift].compact }
134+ assert_equal all_urls, requests
135+ end
136+
137+ it "yields their responses" do
138+ responses = []
139+ stub(scraper).request_one { |url| all_urls.index(url) }
140+ scraper.send :request_all, urls do |response|
141+ responses << response
142+ [next_urls.shift].compact
143+ end
144+ assert_equal (0...all_urls.length).to_a, responses
102145 end
103− assert_equal (0...all_urls.length).to_a, responses
104146 end
105147 end
106148 end
@@ -126,13 +168,13 @@ class FileScraperTest < MiniTest::Spec · 19 unmodified lines
126168 scraper.send :read_file, 'file'
127169 end
128170
129− it "returns the file's content when the file exists" do
130− stub(File).read('file') { 'content' }
171+ it "returns the file's content when the file exists in the source directory" do
172+ stub(File).read(File.join(ROOT_PATH, 'docs', 'scraper', 'file')) { 'content' }
131173 assert_equal 'content', result
132174 end
133175
134176 it "returns nil when the file doesn't exist" do
135− stub(File).read('file') { raise }
177+ stub(File).read(File.join(ROOT_PATH, 'docs', 'scraper', 'file')) { raise }
136178 assert_nil result
137179 end
138180 end
views/unsupported.erb+3−3
@@ -16,11 +16,11 @@ · 15 unmodified lines
1616 <li>iOS 10+</li>
1717 </ul>
1818 <p class="_fail-text">
19− If you're unable to upgrade, I apologize.
20− I decided to prioritize speed and new features over support for older browsers.
19+ If you're unable to upgrade, we apologize.
20+ We decided to prioritize speed and new features over support for older browsers.
2121 </p>
2222 <p class="_fail-text">
23− &mdash; Thibaut <a href="https://twitter.com/DevDocs" class="_fail-link">@DevDocs</a>
23+ &mdash; <a href="https://twitter.com/DevDocs">@DevDocs</a>
2424 </p>
2525 </div>
2626 </body>