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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Offline documentation #12553

Open
4l1fe opened this issue Nov 3, 2022 · 2 comments
Open

[FEATURE] Offline documentation #12553

4l1fe opened this issue Nov 3, 2022 · 2 comments

Comments

@4l1fe
Copy link

4l1fe commented Nov 3, 2022

Problem description

Having Bokeh documentation offline to remove network latency while intensively reading it trough. It also could save some laptop battery and let you to work in a deep forest near a lake without network connectivity 馃檪

Feature description

Due to the conversation in Discource i was recommended by @bryevdv to create an issue to request publishing static documentation's files. They are exist already and are generated by CI i guess.

It isn't yet published as practically plots doesn't work without pulling js files from CDN , therefore, documentation usefulness is questionable. At the same time, a lot of examples and information is accessible, so it make sense to download it for offline usage.

Improvement
I don't know how long and difficult it takes but for improving usefulness plots could be replaced by images, i think readability become better with it, even if we can't interact with plots.

Potential alternatives

No ideas.

Additional information

No response

@4l1fe 4l1fe added the TRIAGE label Nov 3, 2022
@4l1fe 4l1fe changed the title [FEATURE] Offline documentation [FEATURE] Nov 3, 2022
@4l1fe 4l1fe changed the title Offline documentation [FEATURE] [FEATURE] Offline documentation Nov 3, 2022
@bryevdv
Copy link
Member

bryevdv commented Nov 3, 2022

The current deployment tarballs generated by the release-build job have a subdirectory containing the full generated docs. I would propose to zip up this subdirectory and just make it publicly available somewhere in the release deploy-job. That's not too much work, per-se, but I don't want to have to maintain and update an "index" of these docs tarballs every time there is a new one. I'd rather have a single fixed URL with a "file-server" like bucket that will just list all the docs tarballs and users can download whichever they want. I'm not sure if that is possible with S3/Cloudfront, so a little investigation will be in order.

@mattpap mattpap added this to the 3.x milestone Nov 7, 2022
@BhaswatiRoy
Copy link
Contributor

Hello @bryevdv
Instead of putting up the entire documentation in offline mode, can we produce a cheat sheet for the users which covers the points of important plots so that it becomes handy to use? Just like cheat sheets of other py libraries?

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

4 participants