readthedocs / blog

Read the Docs blog
https://blog.readthedocs.com
17 stars 56 forks source link

Add post on Jupyter Book #141

Closed astrojuanlu closed 2 years ago

astrojuanlu commented 2 years ago

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

See https://github.com/executablebooks/jupyter-book/issues/1091 🥳 cc @choldgraf

chrisjsewell commented 2 years ago

Cheers @astrojuanlu

astrojuanlu commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

(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 commented 2 years ago

Companion documentation addition: https://github.com/readthedocs/readthedocs.org/pull/8669

ericholscher commented 2 years ago

(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: https://github.com/readthedocs/readthedocs.org/issues/8670

astrojuanlu commented 2 years ago

🤖 Rendered version: https://readthedocs-blog--141.org.readthedocs.build/jupyter-book-read-the-docs/

astrojuanlu commented 2 years ago

Ready for re-review, only added the intro

choldgraf commented 2 years ago

:shipit: