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

full text search in html docs #645

Closed
jbqubit opened this issue Dec 16, 2016 · 11 comments
Closed

full text search in html docs #645

jbqubit opened this issue Dec 16, 2016 · 11 comments

Comments

@jbqubit
Copy link
Contributor

jbqubit commented Dec 16, 2016

At this URL using Chromium browser (53.0.2785.143) on Linux.
http://m-labs.hk/artiq/manual-release-2

Behavior reproduces for dev branch when I build html on my machine.

@jordens
Copy link
Member

jordens commented Dec 16, 2016

@jbqubit
Copy link
Contributor Author

jbqubit commented Dec 16, 2016

Your search string "pulse" returns

  • artiq.coredevice.ttl.TTLInOut.pulse
  • artiq.coredevice.ttl.TTLOut.pulse
  • etc

However it does not return free-text references to "pulse" in the documentation. This is problematic for other reasonable search terms like: mac, openocd, conda, device_db.pyon.

@jordens jordens changed the title search feature broken in html manual full text search in html docs Dec 18, 2016
@jordens
Copy link
Member

jordens commented Jan 17, 2017

works fine in master

@jordens jordens added this to the 2.2 milestone Jan 17, 2017
@jbqubit
Copy link
Contributor Author

jbqubit commented Jan 25, 2017

I'm on master. I can build html using sphinx 1.5.1. Ubuntu 14.04, Chromium browser. When I load artiq/doc/manual/_build/html/index.html I see a search box on the left-hand side.

  • A search for "EnvExperiment" returns some results but it not a free-text search of all the documentation. It fails to find for example artiq/doc/manual/_build/html/release_notes.html

  • A search for "HDF5" returns no results.

Sorry, something went wrong.

@jbqubit
Copy link
Contributor Author

jbqubit commented Jan 25, 2017

​$ make clean html

file:///home/britton/artiq3/artiq/doc/manual/_build/html/search.html?q=HDF5&check_keywords=yes&area=default

I see animated "Searching..." ​

screenshot from 2017-01-25 17 04 01

Sorry, something went wrong.

@jordens
Copy link
Member

jordens commented Jan 25, 2017

Try downgrading to sphinx 1.4.6 (and make clean html). That fixes it here.

@jbqubit
Copy link
Contributor Author

jbqubit commented Jan 25, 2017 via email

@jordens
Copy link
Member

jordens commented Jan 25, 2017

Your instructions on how we should solve this make me suspect you would like to get involved and do it yourself.

Your instructions are wrong. As you can tell right away from the link I posted above, it works fine on master.
The issue you are seeing locally that I worked around for you is a different one (cross scripting defense) than the one release-2.

@jbqubit
Copy link
Contributor Author

jbqubit commented Jan 25, 2017

I could have been more clear. It's still broken on the URL linked to by "Manual" on the m-labs.hk homepage.

https://m-labs.hk/artiq/
https://m-labs.hk/artiq/manual-release-2/
https://m-labs.hk/artiq/manual-release-2/search.html?q=HDF5&check_keywords=yes&area=default#

@jordens
Copy link
Member

jordens commented Jan 25, 2017

I know. I just explained to you that that one and the one I just resolved for you are different bugs.

jordens added a commit that referenced this issue Jan 25, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants