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

Add post on Jupyter Book #141

Merged
merged 4 commits into from
Nov 11, 2021
Merged

Add post on Jupyter Book #141

merged 4 commits into from
Nov 11, 2021

Conversation

astrojuanlu
Copy link
Contributor

(Only missing the first paragraph, a bit tired now)

See jupyter-book/jupyter-book#1091 🥳 cc @choldgraf

@astrojuanlu astrojuanlu requested a review from a team November 10, 2021 19:42
@chrisjsewell
Copy link

Cheers @astrojuanlu

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

This looks fine assuming the intro is written :) It doesn't have much information, but I think that's fine given that it's mostly just a "yay it works now" blog post.

We should definitely have some of this content in our docs, as well? The blog is good, but I'd hate for it to be the only place this information exists in our content.

jupyter-book-read-the-docs.rst Outdated Show resolved Hide resolved
jupyter-book-read-the-docs.rst Outdated Show resolved Hide resolved
@astrojuanlu
Copy link
Contributor Author

Yay, I'll write the intro tomorrow.

What extra information would you add? For more tutorial or guide-like content, we should add it to our docs I think

@ericholscher
Copy link
Member

What extra information would you add? For more tutorial or guide-like content, we should add it to our docs I think

I don't think we need much more than this content, but mostly just want a search to return...something relevant: https://docs.readthedocs.io/en/latest/?rtd_search=jupyter%20book

Perhaps just a section in an existing doc noting that we support it, to start?

@choldgraf
Copy link

(just as an aside, this reminds me of a conversation I'd had with some Turing Way folks, who mentioned that it would be really helpful if Sphinx let you put search term metadata in a document that would then boost that page in search results that used one of those terms...from this conversation I'm guessing that this isn't possible, but maybe you would find this useful too?)

@astrojuanlu
Copy link
Contributor Author

Companion documentation addition: readthedocs/readthedocs.org#8669

Co-authored-by: Eric Holscher <[email protected]>
@ericholscher
Copy link
Member

(just as an aside, this reminds me of a conversation I'd had with some Turing Way folks, who mentioned that it would be really helpful if Sphinx let you put search term metadata in a document that would then boost that page in search results that used one of those terms...from this conversation I'm guessing that this isn't possible, but maybe you would find this useful too?)

@choldgraf I know we've talked about this in the past, but I asked Santos on our team and we ended up with this issue: readthedocs/readthedocs.org#8670

@astrojuanlu
Copy link
Contributor Author

@astrojuanlu
Copy link
Contributor Author

Ready for re-review, only added the intro

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Ship it!

For example, we started promoting MyST in favor of our recommonmark
:doc:`back in April this year </newsletter-april-2021>`,
and we wrote a guide on :doc:`using Jupyter notebook with Sphinx <readthedocs:guides/jupyter>`
that benefitted a lot from their feedback.
Copy link
Member

Choose a reason for hiding this comment

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

Great summary. ❤️

@astrojuanlu astrojuanlu merged commit 73b074c into main Nov 11, 2021
@astrojuanlu astrojuanlu deleted the jupyter-book branch November 11, 2021 15:59
@choldgraf
Copy link

:shipit:

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.

4 participants