From 08a90d46d6f23607ddecf2a2d9fa216df69d2fac Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 6 Mar 2025 16:47:40 +0100
Subject: [PATCH] [doc] add missing docs for the search.max_page setting

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 docs/admin/settings/settings_search.rst | 6 ++++++
 searx/engines/ask.py                    | 1 +
 searx/engines/google.py                 | 4 ++++
 searx/engines/google_images.py          | 5 +++++
 searx/engines/google_scholar.py         | 4 ++++
 searx/engines/google_videos.py          | 4 ++++
 6 files changed, 24 insertions(+)

diff --git a/docs/admin/settings/settings_search.rst b/docs/admin/settings/settings_search.rst
index 284a6c18b..76441dd0b 100644
--- a/docs/admin/settings/settings_search.rst
+++ b/docs/admin/settings/settings_search.rst
@@ -12,6 +12,7 @@
      favicon_resolver: ""
      default_lang: ""
      ban_time_on_fail: 5
+     max_page: 0
      max_ban_time_on_fail: 120
      suspended_times:
        SearxEngineAccessDenied: 86400
@@ -75,6 +76,11 @@
        - fr
        - fr-BE
 
+``max_page``:
+  If engine supports paging, 0 means unlimited numbers of pages.  The value
+  is only applied if the engine itself does not have a max value that is
+  lower than this one.
+
 ``ban_time_on_fail``:
   Ban time in seconds after engine errors.
 
diff --git a/searx/engines/ask.py b/searx/engines/ask.py
index 82545c417..aeaf6136a 100644
--- a/searx/engines/ask.py
+++ b/searx/engines/ask.py
@@ -20,6 +20,7 @@ about = {
 categories = ['general']
 paging = True
 max_page = 5
+"""Ask.com has at max 5 pages."""
 
 # Base URL
 base_url = "https://www.ask.com/web"
diff --git a/searx/engines/google.py b/searx/engines/google.py
index 10081e92e..c35867eeb 100644
--- a/searx/engines/google.py
+++ b/searx/engines/google.py
@@ -53,6 +53,10 @@ about = {
 categories = ['general', 'web']
 paging = True
 max_page = 50
+"""`Google: max 50 pages`_
+
+.. _Google: max 50 pages: https://github.com/searxng/searxng/issues/2982
+"""
 time_range_support = True
 safesearch = True
 
diff --git a/searx/engines/google_images.py b/searx/engines/google_images.py
index 68fcf6122..89db887b1 100644
--- a/searx/engines/google_images.py
+++ b/searx/engines/google_images.py
@@ -47,6 +47,11 @@ about = {
 categories = ['images', 'web']
 paging = True
 max_page = 50
+"""`Google: max 50 pages`_
+
+.. _Google: max 50 pages: https://github.com/searxng/searxng/issues/2982
+"""
+
 time_range_support = True
 safesearch = True
 send_accept_language_header = True
diff --git a/searx/engines/google_scholar.py b/searx/engines/google_scholar.py
index 8b47360a8..48c303529 100644
--- a/searx/engines/google_scholar.py
+++ b/searx/engines/google_scholar.py
@@ -51,6 +51,10 @@ about = {
 categories = ['science', 'scientific publications']
 paging = True
 max_page = 50
+"""`Google: max 50 pages`_
+
+.. _Google: max 50 pages: https://github.com/searxng/searxng/issues/2982
+"""
 language_support = True
 time_range_support = True
 safesearch = False
diff --git a/searx/engines/google_videos.py b/searx/engines/google_videos.py
index 16b9784bd..9c529e271 100644
--- a/searx/engines/google_videos.py
+++ b/searx/engines/google_videos.py
@@ -61,6 +61,10 @@ about = {
 categories = ['videos', 'web']
 paging = True
 max_page = 50
+"""`Google: max 50 pages`
+
+.. _Google: max 50 pages: https://github.com/searxng/searxng/issues/2982
+"""
 language_support = True
 time_range_support = True
 safesearch = True