Clarify process for working on BokehJS locally
See original GitHub issueIs your feature request related to a problem? Please describe.
When developing locally, including changes to BokehJS, the env var BOKEH_RESOURCES
needs to be set to inline
for the local js to be used and changes to show up.
This env var can be seen in an example in the Developer Guide under “Next Steps,” but I am proposing moving it up, explaining what it does, and making it clear that it’s necessary when making JS changes.
I got bitten by this this weekend. 😃 I also heard it came up in the most recent sprints, but I don’t know much more about that (cc @pavithraes ?).
Describe the solution you’d like
A description of the purpose and effect of BOKEH_RESOURCES=inline
probably under the “Building and Installing” section of the Developer Guide (at least).
Describe alternatives you’ve considered n/a
Additional context cc @tcmetzger @bryevdv
Issue Analytics
- State:
- Created 3 years ago
- Comments:5 (5 by maintainers)
As suggested by @bryevdv, there is now a more detailed paragraph in the dev docs PR (#11513, setup.rst) explaining
absolute-dev
,inline
, andserver-dev
.One should also consider https://docs.bokeh.org/en/latest/docs/dev_guide/bokehjs.html for any long term “working on bokehjs”, though that focuses only on bokehjs development experience, independent of the client setup (e.g. Python vs Scala, etc.), though bokehjs is still biased towards Python (e.g. defaults’ tests).