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

Update quickstart.md to include docs folder #489

Merged
merged 1 commit into from Apr 12, 2023

Conversation

kolibril13
Copy link
Contributor

sphinx projects are often in the "docs folder",
and also the later part of the quick start makes this assumption:
https://myst-nb.readthedocs.io/en/latest/quickstart.html

@welcome
Copy link

welcome bot commented Apr 12, 2023

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.

Welcome to the EBP community! 🎉

@kolibril13
Copy link
Contributor Author

And another idea:
I use virtual python environments, and
which sphinx-build points by default to
/opt/homebrew/bin/sphinx-build.
And that causes the error:

Extension error:
Could not import extension myst_nb (exception: No module named 'myst_nb')

In order to point to the correct sphinx-build in my virtual environment, I had to run
pip install sphinx once, and then it worked without problems

Copy link
Member

@choldgraf choldgraf left a comment

Choose a reason for hiding this comment

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

Seems reasonable to me, thanks !

@choldgraf choldgraf merged commit 0b8a411 into executablebooks:master Apr 12, 2023
10 checks passed
@welcome
Copy link

welcome bot commented Apr 12, 2023

Congrats on your first merged pull request in this project! 🎉
congrats

Thank you for contributing, we are very proud of you! ❤️

agoose77 pushed a commit to aleivag/MyST-NB that referenced this pull request Jun 23, 2023
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