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

latest version of ReadTheDocs not rendering Python code #222

Closed
MattScicluna opened this issue Dec 15, 2022 · 4 comments
Closed

latest version of ReadTheDocs not rendering Python code #222

MattScicluna opened this issue Dec 15, 2022 · 4 comments

Comments

@MattScicluna
Copy link

Expected behaviour

Screen Shot 2022-12-14 at 8 14 34 PM

Actual behaviour

Screen Shot 2022-12-14 at 8 14 16 PM

Steps to reproduce the behavior

Go to: https://opentsne.readthedocs.io/en/latest/examples/02_advanced_usage/02_advanced_usage.html

@pavlin-policar
Copy link
Owner

Hi, thanks for reporting this. I have no idea why this is happening; there haven't been any changes in the documentation for a very long time. Bizarrely, the code blocks seem to be hidden when viewing the latest version of the docs, but show up when viewing the stable, which is openTSNE v0.6.2 works fine.

I've set the default readthedocs page to point to stable, which makes more sense anyways, since most people will be downloading openTSNE from PyPI and not cloning the master branch. So this should fix the immediate problem.

If anyone has any idea on how to fix this, I'd appreciate the help.

@pavlin-policar pavlin-policar changed the title Online Documentation Not Rendering Python Code latest version of ReadTheDocs not rendering Python code Feb 2, 2023
@pavlin-policar
Copy link
Owner

I've re-run the documentation build, and it seems to be working fine in both instances now. I guess something must have gone wrong with the build, but there were no errors in the build log. Either way, I'd say this is now resolved.

@dkobak
Copy link
Contributor

dkobak commented Feb 2, 2023

I googled a bit and found this: stan-dev/cmdstanpy#178 and stan-dev/cmdstanpy#181. The fix there was to use code:: instead of code-block:: and to change ipython3 blocks to python.

You use .. code:: ipython3 blocks e.g. in https://raw.githubusercontent.com/pavlin-policar/openTSNE/master/docs/source/examples/02_advanced_usage/02_advanced_usage.rst, so perhaps replacing ipython3 with python may help? No idea.

@pavlin-policar
Copy link
Owner

Thanks for the links, but it should be fixed now. I guess it was just an error in the readthedocs build that didn't show up in the build logs.

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

No branches or pull requests

3 participants