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

ReadTheDocs notebook rendering broken #6207

Closed
matthew-brett opened this issue Oct 18, 2021 · 12 comments
Closed

ReadTheDocs notebook rendering broken #6207

matthew-brett opened this issue Oct 18, 2021 · 12 comments

Comments

@matthew-brett
Copy link
Contributor

As of a few weeks ago, when I go to, for example, this page:

https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Notebook%20Basics.html

the nbconvert rendering appears to have failed, and the page shows the JSON for the notebook instead of the rendered HTML. This is true for other pages on the site. Is there a problem with the nbconvert rendering of the doc build?

@meeseeksmachine
Copy link

This issue has been mentioned on Jupyter Community Forum. There might be relevant details there:

https://discourse.jupyter.org/t/error-in-jupyter-readthedocs-page-rendering/11038/4

@kevin-bates
Copy link
Member

Hi @matthew-brett - this looks like it might be related to an issue we recently addressed via #6200 (and #6201). I think you'll find the master and latest docs show a more well-rendered examples section.

Please close this issue if you feel they sufficiently address your concern, otherwise let us know what is lacking and we'll see if it can be addressed (and keep this issue open). I believe the stable version of the docs will be updated upon the next release (but that's purely an assumption on my part as I'm not very familiar with read-the-docs itself).

@matthew-brett
Copy link
Contributor Author

Surely it would be a good idea to fix the stable docs now rather when there is some future release? The stable docs are the ones the user will most likely reach.

@matthew-brett
Copy link
Contributor Author

I'm happy to do that if someone gives me permission.

@blink1073
Copy link
Contributor

What is your username on RTD @matthew-brett?

@matthew-brett
Copy link
Contributor Author

I login via Github - so I think it's matthew-brett.

Are there instructions on building and deploying the docs, somewhere?

@kevin-bates
Copy link
Member

Are there instructions on building and deploying the docs, somewhere?

What exists is in the contributing portion of the docs: https://jupyter-notebook.readthedocs.io/en/latest/contributing.html#building-the-documentation.

I login via Github - so I think it's matthew-brett.

I've gone ahead and added you as an RTD maintainer. Thanks for looking at this. I'm curious how one goes about adjusting how the stable meta-tag works because I don't see it. We might find it easier to just produce a 6.4.5 release.

@matthew-brett
Copy link
Contributor Author

matthew-brett commented Oct 19, 2021 via email

@kevin-bates
Copy link
Member

No worries, can't blame you there. I'm assuming I can remove you from the RTD maintainers - are you okay with that?

I'll look into a release and would hope to trigger it sometime today, if not, this week. Thanks for your patience.

@matthew-brett
Copy link
Contributor Author

matthew-brett commented Oct 19, 2021 via email

@kevin-bates
Copy link
Member

Special thanks to @blink1073 for producing the 6.4.5 release!

@matthew-brett - You should find the stable docs appropriately render the examples: https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/examples_index.html

@matthew-brett
Copy link
Contributor Author

Thanks very much for resolving that.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants