This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Search is sluggish
Type: behavior Stage: resolved
Components: Documentation Versions:
process
Status: closed Resolution: duplicate
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: ezio.melotti, georg.brandl, techtonik
Priority: normal Keywords: patch

Created on 2010-01-18 11:22 by techtonik, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
doctools_search_response_speedup.diff techtonik, 2010-01-18 11:22
Messages (4)
msg98002 - (view) Author: anatoly techtonik (techtonik) Date: 2010-01-18 11:22
docs.python.org site search is sluggish or may seem not working at all.

The reason is that before search starts, it requires a 800k+ index file to be loaded http://docs.python.org/searchindex.js

This file is usually cached. You might not notice sluggishness if it was cached when you loaded search page and were typing search query, but when you redirected to search page with get parameters the search is assumed to be started immediately. Unfortunately, JS execution delayed until index is loaded. Time controls are not updated, there is no indication what is going on and search may appear broken. User then clicks search button again and index starts loading anew.

The solution is to load index dynamically after first search request is made.

Attached patch is not tested with real server.
msg98003 - (view) Author: anatoly techtonik (techtonik) Date: 2010-01-18 11:43
It appears the doctools project is outdated and development for documentation generation tools moved to Sphinx project. Patch for Sphinx is in Sphinx bug tracker at http://bitbucket.org/birkenfeld/sphinx/issue/322/improve-search-responsiveness
msg98004 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2010-01-18 11:49
Since you opened a new ticket in the sphinx bug tracker I'll close this one.
msg98006 - (view) Author: anatoly techtonik (techtonik) Date: 2010-01-18 12:02
I would keep this ticket open until the issue is fixed for docs.python.org
History
Date User Action Args
2022-04-11 14:56:56adminsetgithub: 51980
2010-01-18 12:02:47techtoniksetmessages: + msg98006
2010-01-18 11:49:23ezio.melottisetstatus: open -> closed
priority: normal
type: behavior


nosy: + ezio.melotti
messages: + msg98004
resolution: duplicate
stage: resolved
2010-01-18 11:43:35techtoniksetmessages: + msg98003
2010-01-18 11:22:34techtonikcreate