Skip to content

Commit 741d73b

Browse files
authored
Merge pull request #2117 from artemisart/update/pytorch
Update pytorch docs
2 parents 266c880 + 3789d0b commit 741d73b

File tree

5 files changed

+12
-7
lines changed

5 files changed

+12
-7
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ If the latest [documentation versions report](https://github.com/freeCodeCamp/de
6464
Follow the following steps to update documentations to their latest version:
6565

6666
1. Make version/release changes in the scraper file.
67-
2. Check if the license is still correct. If you update `options[:attribution]`, also update the documentation's entry in the array in [`assets/javascripts/templates/pages/about_tmpl.coffee`](../assets/javascripts/templates/pages/about_tmpl.coffee) to match.
67+
2. Check if the license is still correct. Update `options[:attribution]` if needed.
6868
3. If the documentation has a custom icon, ensure the icons in <code>public/icons/*your_scraper_name*/</code> are up-to-date. If you pull the updated icon from a place different than the one specified in the `SOURCE` file, make sure to replace the old link with the new one.
6969
4. If `self.links` is defined, check if the urls are still correct.
7070
5. If the scraper inherits from `FileScraper` rather than `URLScraper`, follow the instructions for that scraper in [`file-scrapers.md`](../docs/file-scrapers.md) to obtain the source material for the scraper.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If you’re adding a new scraper, please ensure that you have:
2222
If you're updating existing documentation to its latest version, please ensure that you have:
2323

2424
- [ ] Updated the versions and releases in the scraper file
25-
- [ ] Ensured the license is up-to-date and that the documentation's entry in the array in `about_tmpl.coffee` matches its data in `self.attribution`
25+
- [ ] Ensured the license is up-to-date
2626
- [ ] Ensured the icons and the `SOURCE` file in <code>public/icons/*your_scraper_name*/</code> are up-to-date if the documentation has a custom icon
2727
- [ ] Ensured `self.links` contains up-to-date urls if `self.links` is defined
2828
- [ ] Tested the changes locally to ensure:

docs/adding-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Adding a documentation may look like a daunting task but once you get the hang o
1616
9. To customize the pages' styling, create an SCSS file in the `assets/stylesheets/pages/` directory and import it in both `application.css.scss` AND `application-dark.css.scss`. Both the file and CSS class should be named `_[type]` where [type] is equal to the scraper's `type` attribute (documentations with the same type share the same custom CSS and JS). Setting the type to `simple` will apply the general styling rules in `assets/stylesheets/pages/_simple.scss`, which can be used for documentations where little to no CSS changes are needed.
1717
10. To add syntax highlighting or execute custom JavaScript on the pages, create a file in the `assets/javascripts/views/pages/` directory (take a look at the other files to see how it works).
1818
11. Add the documentation's icon in the `public/icons/docs/[my_doc]/` directory, in both 16x16 and 32x32-pixels formats. The icon spritesheet is automatically generated when you (re)start your local DevDocs instance.
19-
12. Add the documentation's copyright details to the list in `assets/javascripts/templates/pages/about_tmpl.coffee`. This is the data shown in the table on the [about](https://devdocs.io/about) page, and is ordered alphabetically. Simply copying an existing item, placing it in the right slot and updating the values to match the new scraper will do the job.
19+
12. Add the documentation's copyright details to `options[:attribution]`. This is the data shown in the table on the [about](https://devdocs.io/about) page, and is ordered alphabetically. Please see an existing scraper for the typesetting.
2020
13. Ensure `thor updates:check [my_doc]` shows the correct latest version.
2121

2222
If the documentation includes more than a few hundreds pages and is available for download, try to scrape it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just explain how it works in your pull request.)

lib/docs/filters/pytorch/entries.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ def get_name
1313
# The id of the container `div.section` indicates the page type.
1414
# If the id starts with `module-`, then it's an API reference,
1515
# otherwise it is a note or design doc.
16-
section_id = at_css('.section')['id']
16+
section_id = at_css('.section[id], section[id]')['id']
1717
if section_id.starts_with? 'module-'
1818
section_id.remove('module-')
1919
else

lib/docs/scrapers/pytorch.rb

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,17 @@ class Pytorch < UrlScraper
1616
options[:max_image_size] = 256_000
1717

1818
options[:attribution] = <<-HTML
19-
&copy; 2019 Torch Contributors<br>
19+
&copy; 2019-2024 Torch Contributors<br>
2020
Licensed under the 3-clause BSD License.
2121
HTML
2222

23-
version do
24-
self.release = '1.8.0'
23+
version '2' do
24+
self.release = '2.1'
25+
self.base_url = "https://pytorch.org/docs/#{release}/"
26+
end
27+
28+
version '1' do
29+
self.release = '1.13'
2530
self.base_url = "https://pytorch.org/docs/#{release}/"
2631
end
2732

0 commit comments

Comments
 (0)