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

[docgen] The search box is not working on devel docs #9080

Closed
kaushalmodi opened this issue Sep 26, 2018 · 6 comments
Closed

[docgen] The search box is not working on devel docs #9080

kaushalmodi opened this issue Sep 26, 2018 · 6 comments
Labels
Documentation Content Related to documentation content (not generation).

Comments

@kaushalmodi
Copy link
Contributor

To reproduce the issue:

Also the browser inspector (Ctrl + Shift + I) shows these errors:

Loading failed for the <script> with source “https://nim-lang.github.io/dochack.js”. tut1.html:1202
ReferenceError: search is not defined[Learn More]
tut1.html:1:1
onkeyup
https://nim-lang.github.io/Nim/tut1.html:1:1
@kaushalmodi kaushalmodi changed the title [docgen] The search box is not working [docgen] The search box is not working on devel docs Sep 26, 2018
@andreaferretti andreaferretti added the Documentation Content Related to documentation content (not generation). label Sep 27, 2018
@kaushalmodi
Copy link
Contributor Author

I confirm that this issue exists only on the docs deployed from devel branch. The stable release docs (like the recent 0.19.0 docs have functioning search. Example: Search works fine on https://nim-lang.org/docs/tut1.html ).

So the search is basically broken for folks who build docs locally.

@timotheecour
Copy link
Member

timotheecour commented Oct 4, 2018

this works now; should we close?

image

@kaushalmodi
Copy link
Contributor Author

kaushalmodi commented Oct 4, 2018

Of course it does! I fixed it in a PR ( aab6b31 ), but forgot to reference this commit 😛

Thanks for the ping.

@timotheecour
Copy link
Member

hah! thanks for fixing it then :)

@timotheecour
Copy link
Member

however take a look at #9198 ...

@kaushalmodi
Copy link
Contributor Author

I've just fixed the script placement for dev docs in that commit. I don't know JS at all. So I've pinged the author of the fuzzy search logic in that issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Content Related to documentation content (not generation).
Projects
None yet
Development

No branches or pull requests

3 participants