Search is not working #1487

jmcanterafonseca · 2015-07-25T16:35:02Z

hello,

If I try to search for something under my project http://fiware-orion.readthedocs.org nothing is found regardless the word I enter. Should I do anything to enable search for my project?

thanks

gregmuellegger · 2015-07-27T08:02:16Z

I think the search should work out of the box. So it's not your fault :) We need to investigate this.

jmcanterafonseca · 2015-07-29T16:21:22Z

hello guys,

Any idea on how to fix this?

thanks!

2015-07-27 10:02 GMT+02:00 Gregor Müllegger [email protected]:

I think the search should work out of the box. So it's not your fault :)
We need to investigate this.

—
Reply to this email directly or view it on GitHub
#1487 (comment)
.

gregmuellegger · 2015-07-30T12:21:26Z

@ericholscher @agjohnson any ideas?

jmcanterafonseca · 2015-08-07T17:26:59Z

hello guys, @ericholscher @gregmuellegger @agjohnson

any idea or recommendation on how to solve the issue?

thanks!

ericholscher · 2015-08-11T15:16:49Z

Believe this is a bug with our mkdocs integration. It seems the json builder is breaking when using the theme option. We should have a patch for it soon.

deejay1 · 2015-08-13T11:25:31Z

Don't know if it's related but when I try to build an mkdocs site on my installation of rtd (commit f54d78b) I get:

[13/Aug/2015 13:20:04] DEBUG [readthedocs.search.utils:134] (Search Index) Parsing sections for /data/rtd/media/json/rtfd-tests/latest/tst/foo/index.json
[13/Aug/2015 13:20:04] ERROR [celery.worker.job:282] Task readthedocs.projects.tasks.update_search[0ab34218-5daf-4fd3-a4c7-d4b5c6bdefbf] raised unexpected: KeyError('url',)
Traceback (most recent call last):
  File "/srv/rtd_app/local/lib/python2.7/site-packages/celery/app/trace.py", line 240, in trace_task
    R = retval = fun(*args, **kwargs)
  File "/srv/rtd_app/local/lib/python2.7/site-packages/celery/app/trace.py", line 438, in __protected_call__
    return self.run(*args, **kwargs)
  File "/srv/rtd_app/checkouts/readthedocs.org/readthedocs/projects/tasks.py", line 595, in update_search
    page_list = process_mkdocs_json(version, build_dir=False)
  File "/srv/rtd_app/checkouts/readthedocs.org/readthedocs/search/utils.py", line 28, in process_mkdocs_json
    relative_path = parse_path_from_file(documentation_type='mkdocs', file_path=filename)
  File "/srv/rtd_app/checkouts/readthedocs.org/readthedocs/search/utils.py", line 62, in parse_path_from_file
    path = page_json['url']
KeyError: 'url'

Sample repo is here https://github.com/deejay1/rtfd_test

jmcanterafonseca · 2015-09-24T15:35:47Z

hello,

is there any news about this issue? or any way we can contribute to get it fixed?

thanks

wzrdtales · 2015-10-17T23:40:40Z

I'm also waiting for this...

deejay1 · 2015-10-19T07:11:19Z

What's the current branch I could test and/or deploy from?

justb3a · 2015-12-02T16:40:54Z

Any news about this? Got the same issue.

agjohnson · 2015-12-02T16:53:51Z

No news on this, we haven't focused on the mkdocs integration recently. Anyone willing to look into this is free to take this on.

ghostoy · 2016-01-06T05:27:20Z

Any updates recently? Search is extremely important for our doc.

sahilTakiar · 2016-02-28T20:02:21Z

Would love to see this fixed too

carukc · 2016-04-21T22:23:11Z

We are seeing this problem and the popup menu at the bottom left is missing when building mkdocs... perhaps related. If anyone is working on this perhaps we can assist? We do not know much about the code yet but learn quickly ;)

Current version of xgboost.readthedocs.io has a broken search box. Enabling themes on ReadTheDocs is known to break the search function, as reported in [this document](readthedocs/readthedocs.org#1487). To get around the bug, we replace the `searchtools.js` file with our custom version.

readthedocs/readthedocs.org#1487 using fix here nodemcu/nodemcu-firmware@7dd89dd And added extra_javascript to mkdocs.yml

abaumann · 2017-10-27T22:06:22Z

With the exception of actually hosting docs I'd say search is one of the most important aspects of a documentation site, so +100 for fixing this, but thanks so much for that workaround!

readthedocs/readthedocs.org#1487 using fix here nodemcu/nodemcu-firmware@7dd89dd And added extra_javascript to mkdocs.yml

* Adding the yaml file and separate doc files * renaming the files * moving Migration and Security recommendations * Removed README monolith * fixing spelling error * Fixing spacing of yaml * removing problematic lines * Trying to re-add the secondary menu * Maybe removing the plugin will fix it? * fixing the TOC * Renamed JES to Pipelines API, split out backend files * Split out BE's and a whole bunch of other changes * fixing missing Migration page * Fixing security page * Fixing again? * changing github link, or breaking it... * moving api endpoints into separate docs * another api checkpoint * another endpoint, another formatting thing * The rest of Api endpoints split into different docs * changing menu * removing other references to JES * removing api * making code bigger * backends * additional changes * fixing links? * fixing links * removing migration doc * moving buttons and recreating README * checkpoint * Doc day hints added * Adding CWL page * sample commit * last minute things * import docs * small import doc fix * skeleton * fix list * checkpoint * remove dockathon section * Added note about headers not working in Configuring page * Configuration docs * updated configuration notes * start reformatting global * checkpoint * global options * fixup * Doc-A-Thon cleanup. * Adding note about Security and what to enhance it with * Merged workflow options pages * flesh out runtime attributes * run mode * removed patch * modes * anchor * anchor again * config server * Polishing Imports * Tidy up of WDL and CWL support docs * tutorial map * labels * getting cromwell prioritized over building * Documentation skeletons * adding references to swagger * Updated Call Caching and Configuration for Call Caching * deleting * Update to Labels a few minor tweaks. * removing CWL page * Update Labels - just one link not working * Update LanguageSupport.md Updated/reviewed verbage * tutorial skeletons * cleanup * cleaning up getting help * Update Call caching minor tweaks. Some links do not work, but I am not sure if this is because the page doesn't exist yet and it will? * logging updates * FiveMinuteIntro in progress * FiveMinuteIntro progress * add server mode tutorial * configuration file tutorial * FiveMinuteIntro progress * Update RuntimeAttributes.md Updated some format and verbage. May need another pass. * adding doc suggestion from community * Update swagger yaml, upgrade swagger-ui, metadata still woefully broken * Testing out the autogenerated MD * pretty pictures in server tutorial * moving Persistent Server to Database * overwrite * instrumentation * FiveMinuteIntro progress * docs tweaks * Minor update * FiveMinuteIntro complete * small update * Removing API docs * Changing header level of API * TOS * TOS * Updated Security section and added config section on Logging * minor * minor * fixed links from configuration tutorial * backend pass * Remove giant json example considering it is kind of pointless and very incorrect * persistent tutorial * Update Logging.md Reviewed and updated some verbage. * review/edits * Trying to fix issue with search not working with read the docs: readthedocs/readthedocs.org#1487 using fix here nodemcu/nodemcu-firmware@7dd89dd And added extra_javascript to mkdocs.yml * remove todo * Timing diagram page * fix typo * pipelines 101 tutorial * latest release * hpc intro * remove outdated conf example * google backend * Preliminary polishing touches * Adding CSS to make the max-width wider * Much cleaning, maybe a favicon * Now the Favicon is working! * Checkpoint to add womtool docs * Adding WOMtool docs * Changing highlighting for code block * Final polishes, I hope * fixing new doc site url

Current version of xgboost.readthedocs.io has a broken search box. Enabling themes on ReadTheDocs is known to break the search function, as reported in [this document](readthedocs/readthedocs.org#1487). To get around the bug, we replace the `searchtools.js` file with our custom version.

stsewd · 2018-06-01T20:54:32Z

All projects listed here have a working search, is this still an issue for anyone?

Daniel085 · 2018-06-01T23:07:54Z

This seems to be resolved fo us at least!

ericholscher · 2018-06-02T19:39:05Z

👍

senesis · 2019-02-13T10:46:18Z

Search is not working for https://climaf.readthedocs.io/en/latest/index.html
Do I need to hack as described above ?

ericholscher · 2019-02-13T13:03:11Z

@senesis It looks like you have a really old version of jQuery in your built docs. I believe this is causing the issue.

ericholscher · 2019-02-13T13:04:29Z

Yea, you're running your doc builds with Sphinx v1.2.3, which I'm guessing is the issue.

ericholscher · 2019-02-13T13:06:20Z

I'll also see if we can make our search code work with older jquery, which should hopefully fix it.

ericholscher · 2019-02-13T13:20:49Z

Looks like we broke our fallback in our latest search code. #5285 will fix it.

senesis · 2019-02-13T15:27:40Z

Thanks ! I will also consider upgrading the Sphinx version I use

For details, see readthedocs/readthedocs.org#1487 FIX #153

gregmuellegger added the Bug A bug label Jul 27, 2015

gregmuellegger assigned ericholscher Aug 10, 2015

gregmuellegger added the Priority: high High priority label Aug 10, 2015

SamMarkowitz mentioned this issue Aug 20, 2015

Cannot search docs CloudSlang/CloudSlang.github.io#137

Closed

gregmuellegger added Mkdocs and removed Priority: high High priority labels Sep 14, 2015

agjohnson unassigned ericholscher Dec 2, 2015

geerlingguy mentioned this issue Dec 8, 2015

Search does not work on docs site geerlingguy/drupal-vm#333

Closed

randy3k mentioned this issue Dec 10, 2015

readthedocs documentation JuliaInterop/RCall.jl#79

Closed

marcelstoer mentioned this issue Feb 27, 2016

Search index completely empty #2020

Closed

d0ugal mentioned this issue Feb 28, 2016

MkDocs on ReadTheDocs Search Broken Links mkdocs/mkdocs#848

Closed

sahilTakiar mentioned this issue Feb 28, 2016

ReadTheDocs + MkDocs Search Broken #2025

Closed

wzrdtales mentioned this issue Mar 7, 2016

Cassandra driver db-migrate/node-db-migrate#356

Closed

ghostoy mentioned this issue Mar 15, 2016

search is broken on docs.nwjs.io nwjs/nw.js#4563

Closed

geerlingguy mentioned this issue Apr 22, 2016

Search returns no results when searching using search box on http://docs.drupalvm.com/en/latest/ geerlingguy/drupal-vm#572

Closed

joestewart mentioned this issue May 24, 2016

Readthedocs search bar never yields any results aegir-project/documentation#21

Closed

Aylr mentioned this issue Sep 4, 2017

Read the docs search isn't working - convert to restructured text HealthCatalyst/healthcareai-py#361

Open

This was referenced Oct 23, 2017

Search issues in RTD documentation gammapy/gammapy#1184

Closed

Switch tutorial infrastructure to use Sphinx astropy/astropy-tutorials#153

Merged

abaumann added a commit to broadinstitute/cromwell that referenced this issue Oct 27, 2017

Trying to fix issue with search not working with read the docs:

6b54d28

readthedocs/readthedocs.org#1487 using fix here nodemcu/nodemcu-firmware@7dd89dd And added extra_javascript to mkdocs.yml

katevoss pushed a commit to broadinstitute/cromwell that referenced this issue Oct 31, 2017

Trying to fix issue with search not working with read the docs:

bd40f20

readthedocs/readthedocs.org#1487 using fix here nodemcu/nodemcu-firmware@7dd89dd And added extra_javascript to mkdocs.yml

agjohnson added this to the Mkdocs milestone Nov 17, 2017

anilgursel mentioned this issue Nov 30, 2017

Fix search for documents on ReadTheDocs paypal/squbs#534

Closed

agjohnson modified the milestone: Mkdocs Apr 10, 2018

agjohnson removed the Mkdocs label Apr 10, 2018

PowerKiKi mentioned this issue May 9, 2018

Update mkdocs to the latest #4041

Merged

stsewd added the Needed: more information A reply from issue author is required label Jun 1, 2018

ericholscher closed this as completed Jun 2, 2018

emilesilvis mentioned this issue Nov 22, 2018

Search box not functioning openworm/openworm.github.io#136

Closed

senesis mentioned this issue Feb 13, 2019

Search is (again) not working #5283

Closed

cipri-tom mentioned this issue Jul 10, 2020

Search on the docs site does not work pymupdf/PyMuPDF#374

Closed

perseus928 added a commit to perseus928/PhpSpreadsheet that referenced this issue Nov 16, 2024

Workaround for RTD search

b0b2814

For details, see readthedocs/readthedocs.org#1487 FIX #153

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Search is not working #1487

Search is not working #1487

jmcanterafonseca commented Jul 25, 2015

gregmuellegger commented Jul 27, 2015

jmcanterafonseca commented Jul 29, 2015

gregmuellegger commented Jul 30, 2015

jmcanterafonseca commented Aug 7, 2015

ericholscher commented Aug 11, 2015

deejay1 commented Aug 13, 2015

jmcanterafonseca commented Sep 24, 2015

wzrdtales commented Oct 17, 2015

deejay1 commented Oct 19, 2015

justb3a commented Dec 2, 2015

agjohnson commented Dec 2, 2015

ghostoy commented Jan 6, 2016

sahilTakiar commented Feb 28, 2016

carukc commented Apr 21, 2016

abaumann commented Oct 27, 2017

stsewd commented Jun 1, 2018

Daniel085 commented Jun 1, 2018

ericholscher commented Jun 2, 2018

senesis commented Feb 13, 2019

ericholscher commented Feb 13, 2019

ericholscher commented Feb 13, 2019

ericholscher commented Feb 13, 2019

ericholscher commented Feb 13, 2019

senesis commented Feb 13, 2019

Search is not working #1487

Search is not working #1487

Comments

jmcanterafonseca commented Jul 25, 2015

gregmuellegger commented Jul 27, 2015

jmcanterafonseca commented Jul 29, 2015

gregmuellegger commented Jul 30, 2015

jmcanterafonseca commented Aug 7, 2015

ericholscher commented Aug 11, 2015

deejay1 commented Aug 13, 2015

jmcanterafonseca commented Sep 24, 2015

wzrdtales commented Oct 17, 2015

deejay1 commented Oct 19, 2015

justb3a commented Dec 2, 2015

agjohnson commented Dec 2, 2015

ghostoy commented Jan 6, 2016

sahilTakiar commented Feb 28, 2016

carukc commented Apr 21, 2016

abaumann commented Oct 27, 2017

stsewd commented Jun 1, 2018

Daniel085 commented Jun 1, 2018

ericholscher commented Jun 2, 2018

senesis commented Feb 13, 2019

ericholscher commented Feb 13, 2019

ericholscher commented Feb 13, 2019

ericholscher commented Feb 13, 2019

ericholscher commented Feb 13, 2019

senesis commented Feb 13, 2019