[docs] update docs/configuration links (#5059, #5369, #5423)

mikf · Apr 13, 2024 · 141a93c · 141a93c
1 parent 85bbb59
commit 141a93c
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 24 deletions.
diff --git a/README.rst b/README.rst
@@ -7,8 +7,8 @@ to download image galleries and collections
 from several image hosting sites
 (see `Supported Sites <docs/supportedsites.md>`__).
 It is a cross-platform tool
-with many `configuration options <docs/configuration.rst>`__
-and powerful `filenaming capabilities <docs/formatting.md>`__.
+with many `configuration options <https://gdl-org.github.io/docs/configuration.html>`__
+and powerful `filenaming capabilities <https://gdl-org.github.io/docs/formatting.html>`__.
 
 
 |pypi| |build|
@@ -234,7 +234,7 @@ Documentation
 -------------
 
 A list of all available configuration options and their descriptions
-can be found in `<docs/configuration.rst>`__.
+can be found at `<https://gdl-org.github.io/docs/configuration.html>`__.
 
 | For a default configuration file with available options set to their
   default values, see `<docs/gallery-dl.conf>`__.
@@ -330,7 +330,7 @@ CAPTCHA or similar, or has not been implemented yet, you can use the
 cookies from a browser login session and input them into *gallery-dl*.
 
 This can be done via the
-`cookies <docs/configuration.rst#extractorcookies>`__
+`cookies <https://gdl-org.github.io/docs/configuration.html#extractor-cookies>`__
 option in your configuration file by specifying
 
 - | the path to a Mozilla/Netscape format cookies.txt file exported by a browser addon

diff --git a/docs/supportedsites.md b/docs/supportedsites.md
@@ -947,7 +947,7 @@ Consider all listed sites to potentially be NSFW.
     <td>Wallhaven</td>
     <td>https://wallhaven.cc/</td>
     <td>Collections, individual Images, Search Results, User Profiles</td>
-    <td><a href="configuration.rst#extractorwallhavenapi-key">API Key</a></td>
+    <td><a href="https://gdl-org.github.io/docs/configuration.html#extractor-wallhaven-api-key">API Key</a></td>
 </tr>
 <tr>
     <td>Wallpaper Cave</td>
@@ -965,7 +965,7 @@ Consider all listed sites to potentially be NSFW.
     <td>Weasyl</td>
     <td>https://www.weasyl.com/</td>
     <td>Favorites, Folders, Journals, Submissions</td>
-    <td><a href="configuration.rst#extractorweasylapi-key">API Key</a></td>
+    <td><a href="https://gdl-org.github.io/docs/configuration.html#extractor-weasyl-api-key">API Key</a></td>
 </tr>
 <tr>
     <td>webmshare</td>
@@ -1319,7 +1319,7 @@ Consider all listed sites to potentially be NSFW.
     <td>Derpibooru</td>
     <td>https://derpibooru.org/</td>
     <td>Galleries, Posts, Search Results</td>
-    <td><a href="configuration.rst#extractorderpibooruapi-key">API Key</a></td>
+    <td><a href="https://gdl-org.github.io/docs/configuration.html#extractor-derpibooru-api-key">API Key</a></td>
 </tr>
 <tr>
     <td>Ponybooru</td>

diff --git a/gallery_dl/extractor/deviantart.py b/gallery_dl/extractor/deviantart.py
@@ -1457,9 +1457,8 @@ def _call(self, endpoint, fatal=True, log=True, public=None, **kwargs):
                         self.log.info(
                             "Register your own OAuth application and use its "
                             "credentials to prevent this error: "
-                            "https://github.com/mikf/gallery-dl/blob/master/do"
-                            "cs/configuration.rst#extractordeviantartclient-id"
-                            "--client-secret")
+                            "https://gdl-org.github.io/docs/configuration.html"
+                            "#extractor-deviantart-client-id-client-secret")
             else:
                 if log:
                     self.log.error(msg)

diff --git a/gallery_dl/extractor/reddit.py b/gallery_dl/extractor/reddit.py
@@ -487,14 +487,14 @@ def _call(self, endpoint, params):
 
             remaining = response.headers.get("x-ratelimit-remaining")
             if remaining and float(remaining) < 2:
-                if self._warn_429:
-                    self._warn_429 = False
+                self.log.warning("API rate limit exceeded")
+                if self._warn_429 and self.client_id == self.CLIENT_ID:
                     self.log.info(
                         "Register your own OAuth application and use its "
                         "credentials to prevent this error: "
-                        "https://github.com/mikf/gallery-dl/blob/master"
-                        "/docs/configuration.rst"
-                        "#extractorredditclient-id--user-agent")
+                        "https://gdl-org.github.io/docs/configuration.html"
+                        "#extractor-reddit-client-id-user-agent")
+                self._warn_429 = False
                 self.extractor.wait(
                     seconds=response.headers["x-ratelimit-reset"])
                 continue

diff --git a/gallery_dl/extractor/tumblr.py b/gallery_dl/extractor/tumblr.py
@@ -447,9 +447,9 @@ def _call(self, endpoint, params, **kwargs):
                     if api_key == self.API_KEY:
                         self.log.info(
                             "Register your own OAuth application and use its "
-                            "credentials to prevent this error: https://githu"
-                            "b.com/mikf/gallery-dl/blob/master/docs/configurat"
-                            "ion.rst#extractortumblrapi-key--api-secret")
+                            "credentials to prevent this error: "
+                            "https://gdl-org.github.io/docs/configuration.html"
+                            "#extractor-tumblr-api-key-api-secret")
 
                     if self.extractor.config("ratelimit") == "wait":
                         self.extractor.wait(seconds=reset)

diff --git a/scripts/supportedsites.py b/scripts/supportedsites.py
@@ -342,12 +342,12 @@
 
 _OAUTH = '<a href="https://github.com/mikf/gallery-dl#oauth">OAuth</a>'
 _COOKIES = '<a href="https://github.com/mikf/gallery-dl#cookies">Cookies</a>'
-_APIKEY_DB = \
-    '<a href="configuration.rst#extractorderpibooruapi-key">API Key</a>'
-_APIKEY_WH = \
-    '<a href="configuration.rst#extractorwallhavenapi-key">API Key</a>'
-_APIKEY_WY = \
-    '<a href="configuration.rst#extractorweasylapi-key">API Key</a>'
+_APIKEY_DB = ('<a href="https://gdl-org.github.io/docs/configuration.html'
+              '#extractor-derpibooru-api-key">API Key</a>')
+_APIKEY_WH = ('<a href="https://gdl-org.github.io/docs/configuration.html'
+              '#extractor-wallhaven-api-key">API Key</a>')
+_APIKEY_WY = ('<a href="https://gdl-org.github.io/docs/configuration.html'
+              '#extractor-weasyl-api-key">API Key</a>')
 
 AUTH_MAP = {
     "aibooru"        : "Supported",