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

JUPYTER_PLATFORM_DIRS Warning when adding MyST-NB to existing Sphinx documentation #462

Open
melissawm opened this issue Nov 30, 2022 · 3 comments
Labels
bug Something isn't working

Comments

@melissawm
Copy link

Describe the bug

I am not sure this is the right repo to report this, so apologies if I got it wrong. Please advise and I'll post it somewhere else.

context
When I add myst-nb to the SciPy documentation.

expectation
I expected the mix of rst and myst documentation to be built :)

bug
But instead I get a "JUPYTER_PLATFORM_DIRS" warning/error. Please check the full CircleCI log for details

This also happens when running locally both on Linux and Mac (both using conda).

problem
This is a problem because it prevents the docs from being built, unless the JUPYTER_PLATFORM_DIRS env variable is set. I am hoping we don't need to add this step to our build workflow.

Reproduce the bug

See the CircleCI docs build log

List your environment

myst-nb                   0.17.1             pyhd8ed1ab_0    conda-forge
myst-parser               0.18.1             pyhd8ed1ab_0    conda-forge
nbclient                  0.5.13             pyhd8ed1ab_0    conda-forge
sphinx                    5.3.0              pyhd8ed1ab_0    conda-forge
@melissawm melissawm added the bug Something isn't working label Nov 30, 2022
@welcome
Copy link

welcome bot commented Nov 30, 2022

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@chrisjsewell
Copy link
Member

Hey @melissawm can you also provide the version of jupyter_client and jupyter_core that this occurs for, as it seems relevant.

I think it relates to this: jupyter/jupyter_core#310

This deprecation warning has been observed in nbclient tests also: jupyter/nbclient#261 (comment)

Not sure offhand what the correct "fix" is for this 🤔

@melissawm
Copy link
Author

Here you go:

jupyter_client            7.4.8              pyhd8ed1ab_0    conda-forge
jupyter_core              5.1.0            py39hf3d152e_0    conda-forge

Thanks for looking into it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants