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

Make showing User Guide link optional for jupyter widget #1559

Merged
merged 4 commits into from Jul 29, 2021
Merged

Make showing User Guide link optional for jupyter widget #1559

merged 4 commits into from Jul 29, 2021

Conversation

giswqs
Copy link
Contributor

@giswqs giswqs commented Jul 25, 2021

This pull request resolves the issue #1553. By default, the User Guide URL will always be printed when a map is created. Users can set KeplerGl(show_docs=False) to hide the User Guide URL if needed.

Before:

After:

Signed-off-by: Qiusheng Wu <giswqs@gmail.com>
@giswqs giswqs changed the title Make show User Guide link optional for jupyter widget Make showing User Guide link optional for jupyter widget Jul 25, 2021
@heshan0131
Copy link
Contributor

heshan0131 commented Jul 29, 2021

Can you add this to the documentation here?
https://github.com/keplergl/kepler.gl/blob/master/docs/keplergl-jupyter/README.md

@giswqs
Copy link
Contributor Author

giswqs commented Jul 29, 2021

@heshan0131 I have added the following to the documentation.

By default, the User Guide URL (https://docs.kepler.gl/docs/keplergl-jupyter) will be printed when a map is created. To hide the User Guide URL, set show_docs=False.

# Hide the User Guide URL
from keplergl import KeplerGl
map_1 = KeplerGl(show_docs=False)
map_1

@@ -90,6 +90,16 @@ map_1

![empty map][empty_map]

By default, the User Guide URL (<https://docs.kepler.gl/docs/keplergl-jupyter>) will be printed when a map is created. To hide the User Guide URL, set `show_docs=False`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move this to after __config__ on line 77, because it is an additional argument for KeplerGl

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated. Thanks.

image

Signed-off-by: Qiusheng Wu <giswqs@gmail.com>
@heshan0131
Copy link
Contributor

target release keplergl 0.3.1

@heshan0131 heshan0131 merged commit 089bb7a into keplergl:master Jul 29, 2021
lixun910 pushed a commit to lixun910/kepler.gl that referenced this pull request Aug 13, 2021
…eplergl#1559)

* Make show User Guide link optional for jupyter
* Updated README with shows_docs parameter

Signed-off-by: Qiusheng Wu <giswqs@gmail.com>
Signed-off-by: Xun Li <lixun910@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants