Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken URLs #1125

Merged
merged 3 commits into from
Feb 26, 2023
Merged

Fix broken URLs #1125

merged 3 commits into from
Feb 26, 2023

Conversation

adamjstewart
Copy link
Collaborator

TIL you can run:

$ cd docs
$ make linkcheck

and Sphinx will parse and check all external links in your docs and warn you which links are broken. Unfortunately there are too many false positives to make this a CI test, but this may be something we want to check before each release.

@adamjstewart adamjstewart added this to the 0.4.1 milestone Feb 18, 2023
@github-actions github-actions bot added datasets Geospatial or benchmark datasets documentation Improvements or additions to documentation trainers PyTorch Lightning trainers transforms Data augmentation transforms labels Feb 18, 2023
@@ -19,7 +19,7 @@
"source": [
"# PyTorch Lightning Trainers\n",
"\n",
"In this tutorial, we demonstrate TorchGeo trainers to train and test a model. Specifically, we use the [Tropical Cyclone dataset](https://torchgeo.readthedocs.io/en/latest/api/datasets.html#tropical-cyclone-wind-estimation-competition) and train models to predict cyclone wind speed given imagery of the cyclone. \n",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dataset was renamed and link broke

torchgeo/datasets/chesapeake.py Outdated Show resolved Hide resolved
* `Class Descriptions
<https://chesapeakeconservancy.org/wp-content/uploads/2020/03/LC_Class_Descriptions.pdf>`_
* `Accuracy Assessment
<https://chesapeakeconservancy.org/wp-content/uploads/2017/01/Chesapeake_Conservancy_Accuracy_Assessment_Methodology.pdf>`_
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of these links are broken. Most of these docs are linked on the main dataset page, so I don't think we need to explicitly reference them.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine with me

@@ -35,7 +35,7 @@ class EnviroAtlas(GeoDataset):
This dataset was organized to accompany the 2022 paper, `"Resolving label
uncertainty with implicit generative models"
<https://openreview.net/forum?id=AEa_UepnMDX>`_. More details can be found at
https://github.com/estherrolf/qr_for_landcover.
https://github.com/estherrolf/implicit-posterior.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many of these are repo renames. The old URL still works and redirects to the correct page, but figured we should update them anyway.

"https://raw.githubusercontent.com/chaozhong2010/VHR-10_dataset_coco/"
"master/NWPU%20VHR-10_dataset_coco/annotations.json"
),
"url": "https://raw.githubusercontent.com/chaozhong2010/VHR-10_dataset_coco/ce0ba0f5f6a0737031f1cbe05e785ddd5ef05bd7/NWPU%20VHR-10_dataset_coco/annotations.json", # noqa: E501
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should never download files from the master branch, they may change or move to a different location. Instead, we should use permalinks when available.

calebrob6
calebrob6 previously approved these changes Feb 23, 2023
@adamjstewart
Copy link
Collaborator Author

Tests aren't going to pass until the notebook tests are passing. But that test isn't required, this PR can be merged whenever.

@calebrob6 calebrob6 merged commit faa0503 into main Feb 26, 2023
@calebrob6 calebrob6 deleted the docs/fix-urls branch February 26, 2023 18:14
calebrob6 pushed a commit that referenced this pull request Apr 10, 2023
* Fix broken URLs

* Flake8 fix

* Don't change Chesapeake URL
yichiac pushed a commit to yichiac/torchgeo that referenced this pull request Apr 29, 2023
* Fix broken URLs

* Flake8 fix

* Don't change Chesapeake URL
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
datasets Geospatial or benchmark datasets documentation Improvements or additions to documentation trainers PyTorch Lightning trainers transforms Data augmentation transforms
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants