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: Missing search bar on docs.python.org
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Harrison Chudleigh, docs@python, mdk, willingc, xtreak, yselivanov
Priority: normal Keywords: patch

Created on 2018-09-19 09:28 by Harrison Chudleigh, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 9431 merged yselivanov, 2018-09-19 21:45
Messages (14)
msg325737 - (view) Author: Harrison Chudleigh (Harrison Chudleigh) Date: 2018-09-19 09:28
The search bar is missing from docs.python.org, probably as a result of a minor error in the webpage. This is a quite recent change, as the search bar is still there in a web.archive.org snapshot from the 13th of September (last week). Could someone please fix this? Thanks.
msg325756 - (view) Author: Karthikeyan Singaravelan (xtreak) * (Python committer) Date: 2018-09-19 12:59
Strange it's present on both 3.8.a0 and for 3.6.6 but not for 3.7.0

Thanks
msg325785 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2018-09-19 19:21
Confirming that I see the same behavior as reported by @xtreak.
msg325789 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2018-09-19 19:54
I can reproduce it locally [1]. The Python logo at the left dissapear to, it goes from "[LOGO] Python »" to "3.7.0 Documentation »".

Did not spotted recent changes in the theme / docsbuild-scripts / cpython/Doc for the moment, but now I can inspect locally.

Local reproduction with a fresh clone of docsbuild-scripts:

    $ mkdir -p www logs build_root
    $ python3 -m venv build_root/venv/
    $ build_root/venv/bin/python -m pip install -r requirements.txt
    $ python3 ./build_docs.py --quick --build-root build_root --www-root www --log-directory logs --group $(id -g) --branch 3.7
    $ (cd www/3.7/; python3 -m http.server)
msg325790 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2018-09-19 20:05
I got it back by building with 90f7d455b (7 days ago), so I'm git bisecting...
msg325791 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2018-09-19 20:11
@mdk The asyncio folks did make a change to the layout in https://github.com/python/cpython/pull/9364 . It's a bit weird that 3.7 is the release that is missing the search bar.
msg325792 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2018-09-19 20:13
Yes, got it too : 512d7101098b971837cbb406942215244f636547, they literally removed the searchbox:

$ git show 512d7101098b971837cbb406942215244f636547 | grep searchbox
-{%- macro searchbox() %}
-{# modified from sphinx/themes/basic/searchbox.html #}
-        {{ searchbox() }}
-            '<input type="text" value="" id="searchbox" style="width: 50%">',
-            '<input type="submit" id="searchbox-submit" value="Filter"></p>'
-                  var query = new RegExp($('#searchbox').val(), 'i');
-          $('#searchbox').keyup(dofilter);
-          $('#searchbox-submit').click(dofilter);
msg325794 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2018-09-19 20:18
Oh, this is a result of asyncio docs 3.8 -> 3.7 backport. I'll fix this.
msg325796 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2018-09-19 20:19
Does master and 3.7 branch build the docs at different times? It's odd to me that master still shows the search box and 3.7 does not.

I'm getting on a flight soon. Yury would be a good person to ping re: changing.
msg325797 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2018-09-19 20:20
Thanks Yuri (and thanks for the rewrite!)
msg325803 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2018-09-19 21:47
> Does master and 3.7 branch build the docs at different times? It's odd to me that master still shows the search box and 3.7 does not.

layout.html was refactored in 3.8: scripts were moved into separate files.  I accidentally copied it from 3.8 to 3.7, where those new scripts are not available.
msg325804 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2018-09-19 21:51
New changeset 581890cda36f60cd46185c6e184abe35a95813a2 by Yury Selivanov in branch '3.7':
bpo-34733: Return of the docs search bar (GH-9431)
https://github.com/python/cpython/commit/581890cda36f60cd46185c6e184abe35a95813a2
msg325805 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2018-09-19 21:52
Closing this now, please reopen if there's still no search bar in a few hours.
msg325832 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2018-09-19 23:55
Aaand... it's back.
History
Date User Action Args
2022-04-11 14:59:06adminsetgithub: 78914
2018-09-19 23:55:16yselivanovsetmessages: + msg325832
2018-09-19 21:52:50yselivanovsetstatus: open -> closed
resolution: fixed
messages: + msg325805

stage: patch review -> resolved
2018-09-19 21:51:20yselivanovsetmessages: + msg325804
2018-09-19 21:47:28yselivanovsetmessages: + msg325803
2018-09-19 21:45:38yselivanovsetkeywords: + patch
stage: patch review
pull_requests: + pull_request8848
2018-09-19 20:20:24mdksetmessages: + msg325797
2018-09-19 20:19:46willingcsetmessages: + msg325796
2018-09-19 20:18:25yselivanovsetmessages: + msg325794
2018-09-19 20:13:55mdksetnosy: + yselivanov
2018-09-19 20:13:44mdksetmessages: + msg325792
2018-09-19 20:11:59willingcsetmessages: + msg325791
2018-09-19 20:05:11mdksetmessages: + msg325790
2018-09-19 19:54:23mdksetmessages: + msg325789
stage: needs patch -> (no value)
2018-09-19 19:21:13willingcsetversions: + Python 3.7
nosy: + willingc

messages: + msg325785

stage: needs patch
2018-09-19 17:02:14ned.deilysetnosy: + mdk
2018-09-19 12:59:53xtreaksetnosy: + xtreak
messages: + msg325756
2018-09-19 09:28:10Harrison Chudleighcreate