docs: mention that search is only active for 2+ pages

mitmproxy · Oct 17, 2023 · 58df5c0 · 58df5c0
1 parent 2126e60
commit 58df5c0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/pdoc/__main__.py b/pdoc/__main__.py
@@ -112,7 +112,7 @@
     "--search",
     action=BooleanOptionalAction,
     default=True,
-    help="Enable search functionality.",
+    help="Enable search functionality if multiple modules are documented.",
 )
 renderopts.add_argument(
     "--show-source",

diff --git a/pdoc/search.py b/pdoc/search.py
@@ -5,6 +5,11 @@
 search box for the first time, pdoc will fetch the search index (`search.js`) and use that to
 answer all upcoming queries.
 
+##### Single-Page Documentation
+
+If pdoc is documenting a single module only, search functionality will be disabled.
+The browser's built-in search functionality will provide a better user experience in these cases.
+
 ##### Search Coverage
 
 The search functionality covers all documented elements and their docstrings.