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

Generate a file where all documented symbols are listed (documented.json) #1085

Open
erdnussflips opened this issue Jul 19, 2019 · 11 comments
Open

Comments

@erdnussflips
Copy link

It would be useful to generate a "documented.json" file parallel to the "undocumented.json" file, in which all symbols that are already documented are listed.

@rashenoy
Copy link

rashenoy commented Mar 1, 2021

Is there any way to do it, say using some other external tool ?
I am trying to have live search within Jazzy search as mentioned here.. https://pspdfkit.com/blog/2016/adding-live-search-to-jazzy/
However, it needs a json having all the documented items.
Alternatively, if there is a build param that I can use to have this enabled by default, I will be happy to do it.
By not having --disable-search, I just see the search box. But it doesnt really do the search.

@johnfairh
Copy link
Collaborator

Yes you could generate a documented.json file by processing the 'search.json'.

What do you mean it doesnt really do the search ? Search is in the apple and fullwidth theme.

Screenshot 2021-03-01 at 10 48 57

@rashenoy
Copy link

rashenoy commented Mar 1, 2021

Thanks for the update. I am using apple theme. When I type something in the search window it doesnt bring down the list like you have shown. If I hit enter, it just opens the search.json in the browser tab.
Screenshot 2021-03-01 at 4 29 20 PM

@johnfairh
Copy link
Collaborator

that means you are using file:/// urls and have not disabled local file restrictions

@rashenoy
Copy link

rashenoy commented Mar 1, 2021

Thanks. Since I push the documentation (html tree) to our server, what changes are needed during Jazzy build ?

@johnfairh
Copy link
Collaborator

no changes are needed - have you tried the search on a server yet?

@rashenoy
Copy link

rashenoy commented Mar 1, 2021

yes. Nothing happens when I enter the text in the search box.

@johnfairh
Copy link
Collaborator

johnfairh commented Mar 1, 2021

if you're sure you've uploaded all the files and are definitely using an http[s] url to access it then you should open an issue with a demo -- given that the search works widely though, it is likely to be a configuration/browser issue

@rashenoy
Copy link

rashenoy commented Mar 1, 2021

the documentation is on a server under https. Is that a problem ? If so what changes are required on the server side ?

@johnfairh
Copy link
Collaborator

no, https is fine

@rashenoy
Copy link

rashenoy commented Mar 1, 2021

Thanks for the support. will check internally if there are any restrictions on js.

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