From bde37867d84190e86d3b3ffac81918e4b476aa2d Mon Sep 17 00:00:00 2001
From: Antoine Lambert <anlambert@softwareheritage.org>
Date: Thu, 6 Feb 2025 14:33:25 +0100
Subject: [PATCH] docs: Fix broken external links
Those were spotted thanks to the sphinx linkcheck builder
---
docs/tutorial.rst | 8 ++++----
swh/lister/cpan/__init__.py | 4 ++--
swh/lister/dlang/__init__.py | 2 +-
swh/lister/gitea/lister.py | 4 ++--
swh/lister/github/lister.py | 2 +-
5 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
index eafafd9c..5e1b5528 100644
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@@ -374,7 +374,7 @@ More about listers
See current implemented listers as examples (GitHub_, Bitbucket_, CGit_, GitLab_ ).
-.. _GitHub: https://forge.softwareheritage.org/source/swh-lister/browse/master/swh/lister/github/lister.py
-.. _Bitbucket: https://forge.softwareheritage.org/source/swh-lister/browse/master/swh/lister/bitbucket/lister.py
-.. _CGit: https://forge.softwareheritage.org/source/swh-lister/browse/master/swh/lister/cgit/lister.py
-.. _GitLab: https://forge.softwareheritage.org/source/swh-lister/browse/master/swh/lister/gitlab/lister.py
+.. _GitHub: https://gitlab.softwareheritage.org/swh/devel/swh-lister/-/blob/master/swh/lister/github/lister.py
+.. _Bitbucket: https://gitlab.softwareheritage.org/swh/devel/swh-lister/-/blob/master/swh/lister/bitbucket/lister.py
+.. _CGit: https://gitlab.softwareheritage.org/swh/devel/swh-lister/-/blob/master/swh/lister/cgit/lister.py
+.. _GitLab: https://gitlab.softwareheritage.org/swh/devel/swh-lister/-/blob/master/swh/lister/gitlab/lister.py
diff --git a/swh/lister/cpan/__init__.py b/swh/lister/cpan/__init__.py
index 26241126..b34561b1 100644
--- a/swh/lister/cpan/__init__.py
+++ b/swh/lister/cpan/__init__.py
@@ -58,10 +58,10 @@ You can follow lister execution by displaying logs of swh-lister service::
.. _cpan.org: https://cpan.org/
.. _metacpan.org: https://metacpan.org/
.. _http api endpoint: https://explorer.metacpan.org/?url=/release/
-.. _search: https://github.com/metacpan/metacpan-api/blob/master/docs/API-docs.md#search-without-constraints # noqa: B950
+.. _search: https://github.com/metacpan/metacpan-api/blob/master/docs/API-docs.md#search-without-constraints
-"""
+""" # noqa: B950
def register():
diff --git a/swh/lister/dlang/__init__.py b/swh/lister/dlang/__init__.py
index 930f95f7..fcb9fd15 100644
--- a/swh/lister/dlang/__init__.py
+++ b/swh/lister/dlang/__init__.py
@@ -62,7 +62,7 @@ You can follow lister execution by displaying logs of swh-lister service::
.. _Dlang: https://dlang.org/
.. _DUB: https://code.dlang.org/
-.. _http api endpoint: https://code.dlang.org/api/packages/dump"
+.. _http api endpoint: https://code.dlang.org/api/packages/dump
"""
diff --git a/swh/lister/gitea/lister.py b/swh/lister/gitea/lister.py
index e429756a..8845ab07 100644
--- a/swh/lister/gitea/lister.py
+++ b/swh/lister/gitea/lister.py
@@ -13,10 +13,10 @@ logger = logging.getLogger(__name__)
class GiteaLister(GogsLister):
"""List origins from Gitea.
- Gitea API documentation: https://try.gitea.io/api/swagger
+ Gitea API documentation: https://gitea.com/api/swagger
The API does pagination and provides navigation URLs through the 'Link' header.
The default value for page size is the maximum value observed on the instances
- accessible at https://try.gitea.io/api/v1/ and https://codeberg.org/api/v1/."""
+ accessible at https://gitea.com/api/v1/ and https://codeberg.org/api/v1/."""
LISTER_NAME = "gitea"
diff --git a/swh/lister/github/lister.py b/swh/lister/github/lister.py
index 986f3d6d..8712d361 100644
--- a/swh/lister/github/lister.py
+++ b/swh/lister/github/lister.py
@@ -52,7 +52,7 @@ class GitHubLister(Lister[GitHubListerState, List[Dict[str, Any]]]):
When the credentials aren't set in the lister config, the lister can run in
anonymous mode too (e.g. for testing purposes).
- .. _abuse rate limit policy: https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits
+ .. _abuse rate limit policy: https://developer.github.com/v3/guides/best-practices-for-integrators/#handle-rate-limit-errors-appropriately
Args:
--
GitLab