Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Search is not working #1487

Closed
jmcanterafonseca opened this issue Jul 25, 2015 · 33 comments
Closed

Search is not working #1487

jmcanterafonseca opened this issue Jul 25, 2015 · 33 comments
Labels
Bug A bug Needed: more information A reply from issue author is required
Milestone

Comments

@jmcanterafonseca
Copy link

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 gregmuellegger added the Bug A bug label Jul 27, 2015
@gregmuellegger
Copy link
Contributor

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

@jmcanterafonseca
Copy link
Author

hello guys,

Any idea on how to fix this?

thanks!

2015-07-27 10:02 GMT+02:00 Gregor Müllegger notifications@github.com:

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
Copy link
Contributor

@ericholscher @agjohnson any ideas?

@jmcanterafonseca
Copy link
Author

hello guys, @ericholscher @gregmuellegger @agjohnson

any idea or recommendation on how to solve the issue?

thanks!

@ericholscher
Copy link
Member

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
Copy link
Contributor

deejay1 commented Aug 13, 2015

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
Copy link
Author

hello,

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

thanks

@wzrdtales
Copy link

I'm also waiting for this...

@deejay1
Copy link
Contributor

deejay1 commented Oct 19, 2015

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

@justb3a
Copy link

justb3a commented Dec 2, 2015

Any news about this? Got the same issue.

@agjohnson
Copy link
Contributor

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
Copy link

ghostoy commented Jan 6, 2016

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

@sahilTakiar
Copy link

Would love to see this fixed too

@carukc
Copy link

carukc commented Apr 21, 2016

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 ;)

terrytangyuan pushed a commit to dmlc/xgboost that referenced this issue Sep 27, 2017
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.
abaumann added a commit to broadinstitute/cromwell that referenced this issue Oct 27, 2017
@abaumann
Copy link

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!

katevoss pushed a commit to broadinstitute/cromwell that referenced this issue Oct 31, 2017
katevoss added a commit to broadinstitute/cromwell that referenced this issue Oct 31, 2017
* 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
@agjohnson agjohnson added this to the Mkdocs milestone Nov 17, 2017
CodingCat pushed a commit to CodingCat/xgboost that referenced this issue Dec 29, 2017
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.
@agjohnson agjohnson modified the milestone: Mkdocs Apr 10, 2018
@agjohnson agjohnson removed the Mkdocs label Apr 10, 2018
@stsewd
Copy link
Member

stsewd commented Jun 1, 2018

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

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

This seems to be resolved fo us at least!

@ericholscher
Copy link
Member

👍

@senesis
Copy link

senesis commented Feb 13, 2019

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

@ericholscher
Copy link
Member

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

@ericholscher
Copy link
Member

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

@ericholscher
Copy link
Member

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

@ericholscher
Copy link
Member

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

@senesis
Copy link

senesis commented Feb 13, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug Needed: more information A reply from issue author is required
Projects
None yet
Development

No branches or pull requests