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

set dash keyword to module name #423

Closed
breathe opened this issue Dec 17, 2015 · 5 comments · Fixed by #581
Closed

set dash keyword to module name #423

breathe opened this issue Dec 17, 2015 · 5 comments · Fixed by #581

Comments

@breathe
Copy link

breathe commented Dec 17, 2015

Is it possible to customize the keyword of generated dash docsets? I'm able to build a dash docset with jazzy (great -- thanks!!) and I am hosting a dash feed url. Via the dash feed url I'm able download/install the dash bundle as expected. But the default keyword for docset search of my docset is set to 'jazzy:' -- is it possible to customize this when building the docset?

@jpsim
Copy link
Collaborator

jpsim commented Dec 17, 2015

There's no way to do that today via jazzy's public interface. I'm actually not familiar with this feature of Dash, is there some documentation in Dash for the "keyword" feature you're referring to so I can learn more about it?

What does this do? What value should this be set to in normal usage? Thanks!

@breathe
Copy link
Author

breathe commented Dec 17, 2015

This feature is used to allow filtering search to specific datasets -- in any dash search context I can enter "dataset_keyword": and subsequent characters are searched for only within that dataset. The desired value tends to be something close to the project name or a common abbreviation for it.

I looked through the Dash docs but haven't been able to find anything that I could identify as related to this ... For clarity -- here's an image showing the keyword name for some of the various datasets I have loaded (its the value in the right-hand column) -- dash allows the end user to customize the keyword<->dataset mappings if they want -- however the dataset provider seems to also be able to provide a default value -- in this screenshot you can see sensible keyword values for the various dataset bundles I have loaded (and I have not customized any of the dataset names shown)... Any docset I load which is built with jazzy provides the keyword name "jazzy" ...

screen shot 2015-12-17 at 2 36 20 pm

@jpsim
Copy link
Collaborator

jpsim commented Dec 17, 2015

Seems like we should be setting this value to the module name then.

@jpsim
Copy link
Collaborator

jpsim commented Dec 17, 2015

Thanks for this information, @breathe!

@jpsim jpsim changed the title dash bundle should support default keyword shortcut? set dash keyword to module name Dec 17, 2015
jpsim added a commit that referenced this issue Jun 10, 2016
@jpsim
Copy link
Collaborator

jpsim commented Jun 10, 2016

alright this is finally fixed! Thanks for your patience @breathe!

@istx25 istx25 modified the milestone: The Past Nov 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants