Unified · Split
| @@ -0,0 +1,71 @@ | |||
| 1 | # File Scraper Reference | ||
| 2 | |||
| 3 | This lists the docs that use `FileScraper` and instructions for building some of them. | ||
| 4 | |||
| 5 | If you open a PR to update one of these docs, please add/fix the instructions. | ||
| 6 | |||
| 7 | ## C | ||
| 8 | |||
| 9 | Download the HTML book from https://en.cppreference.com/w/Cppreference:Archives | ||
| 10 | and copy `reference/en/c` from the ZIP file into `/path/to/devdocs/docs/c`. | ||
| 11 | |||
| 12 | ## C++ | ||
| 13 | |||
| 14 | Download the HTML book from https://en.cppreference.com/w/Cppreference:Archives | ||
| 15 | and copy `reference/en/cpp` from the ZIP file into `/path/to/devdocs/docs/cpp`. | ||
| 16 | |||
| 17 | ## Dart | ||
| 18 | |||
| 19 | Click the “API docs” link under the “Stable channel” header on | ||
| 20 | https://www.dartlang.org/tools/sdk/archive. Rename the expanded ZIP to `dart~2` | ||
| 21 | and put it in `/path/to/devdocs/docs/` | ||
| 22 | |||
| 23 | ## Django | ||
| 24 | |||
| 25 | Go to https://docs.djangoproject.com/, select the version from the | ||
| 26 | bubble in the bottom-right corner, then download the HTML version from the sidebar. | ||
| 27 | |||
| 28 | ## Erlang | ||
| 29 | |||
| 30 | Go to https://www.erlang.org/downloads and download the HTML documentation file. | ||
| 31 | |||
| 32 | ## Gnu | ||
| 33 | |||
| 34 | ### GCC | ||
| 35 | ### GNU Fortran | ||
| 36 | |||
| 37 | ## NumPy | ||
| 38 | |||
| 39 | ## OpenJDK | ||
| 40 | |||
| 41 | ## Perl | ||
| 42 | |||
| 43 | ## PHP | ||
| 44 | |||
| 45 | ## Python | ||
| 46 | |||
| 47 | ## RDoc | ||
| 48 | |||
| 49 | ### Nokogiri | ||
| 50 | ### Ruby / Minitest | ||
| 51 | ### Ruby on Rails | ||
| 52 | ### Ruby | ||
| 53 | |||
| 54 | ## Salt Stack | ||
| 55 | |||
| 56 | Replace `2019.2` with the correct tag. | ||
| 57 | |||
| 58 | ```sh | ||
| 59 | git clone https://github.com/saltstack/salt.git --branch 2019.2 --depth 1 | ||
| 60 | cd salt/doc | ||
| 61 | pip install sphinx | ||
| 62 | make html | ||
| 63 | ``` | ||
| 64 | |||
| 65 | The generated html is in `salt/doc/_build/html`. Copy it to | ||
| 66 | |||
| 67 | ## Scala | ||
| 68 | |||
| 69 | See `lib/docs/scrapers/scala.rb` | ||
| 70 | |||
| 71 | ## SQLite | ||
| @@ -20,8 +20,6 @@ module Docs · 19 unmodified lines | |||
| 20 | Licensed under the Creative Commons Attribution-ShareAlike License v4.0. | 20 | Licensed under the Creative Commons Attribution-ShareAlike License v4.0. |
| 21 | HTML | 21 | HTML |
| 22 | 22 | ||
| 23 | # Download the documentation from https://www.dartlang.org/tools/sdk/archive | ||
| 24 | |||
| 25 | version '2' do | 23 | version '2' do |
| 26 | self.release = '2.5.0' | 24 | self.release = '2.5.0' |
| 27 | self.base_url = "https://api.dart.dev/stable/#{release}/" | 25 | self.base_url = "https://api.dart.dev/stable/#{release}/" |
| @@ -1,13 +1,5 @@ | |||
| 1 | module Docs | 1 | module Docs |
| 2 | # The official documentation website is heavily rate-limited | 2 | # The official documentation website is heavily rate-limited |
| 3 | # | ||
| 4 | # The documentation can be generated like this (replace 2019.2 with the correct tag): | ||
| 5 | # $ git clone https://github.com/saltstack/salt.git --branch 2019.2 --depth 1 | ||
| 6 | # $ cd salt/doc | ||
| 7 | # $ pip install sphinx | ||
| 8 | # $ make html | ||
| 9 | # | ||
| 10 | # The generated html can be found in salt/doc/_build/html | ||
| 11 | class SaltStack < FileScraper | 3 | class SaltStack < FileScraper |
| 12 | self.type = 'simple' | 4 | self.type = 'simple' |
| 13 | self.slug = 'saltstack' | 5 | self.slug = 'saltstack' |