question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Built-in Sphinx documentation search index broken (also, search link hard to find)

See original GitHub issue

First of all it’s pretty hard to find the search at all in the docs (would be useful in the sidebar) but there is a link at the bottom of the docs homepage: https://docs.pipenv.org/

Which points to this page: https://docs.pipenv.org/search/

Actually searching for something like this: https://docs.pipenv.org/search/?q=test Results in links like these which only result in 404s: https://docs.pipenv.org/en/latest/advanced?highlight=test

The problem seems to be that the search index uses the standard readthedocs urls containing the versions (/en/latest/) instead of using the root. I’m not entirely sure if this bug is restricted to this project’s configuration or if it’s an upstream bug.

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:25 (15 by maintainers)

github_iconTop GitHub Comments

1reaction
uranusjrcommented, Jul 31, 2018

I dug into this a little and unfortunately this behaviour is fixed on readthedocs, and all that is possible is to add redirect rules on the reverse proxy (i.e. on the docs.pipenv.org server). In other words, this can only be done by @kennethreitz, by adding redirect rules from /en/latest/(.*) to /$1 (using the NGINX syntax as an example).

1reaction
techalchemycommented, Mar 30, 2018

This is fixed

Read more comments on GitHub >

github_iconTop Results From Across the Web

Configuration - Sphinx documentation
Directories in which to search for additional message catalogs (see language ), relative to the source directory. The directories on this path are...
Read more >
Sphinx 2.3.2-beta reference manual
searchd utility will serve all the specified indexes, and the clients can specify what indexes to search in run time. 3.6. Restrictions on...
Read more >
Read the docs search broken - Stack Overflow
I already tried to install an older version of sphinx 1.7.9 but this did also not solve the problem. – New2Coding. Sep 24,...
Read more >
Sphinx Documentation - Read the Docs
For example, to document Python's built-in function ... Sphinx then searches for all images matching the provided pattern and determines ...
Read more >
Documentation about the built in search? - Google Groups
Charles Bouchard-Légaré · The Javascript code for doing the actual search against the index is at sphinx/themes/basic/static/searchtools. · The generation of the ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found