isl-org / Open3D

Open3D: A Modern Library for 3D Data Processing
http://www.open3d.org
Other
11.55k stars 2.32k forks source link

Code blocks in documentation are unreadable (white on light grey) #6820

Open themightyoarfish opened 5 months ago

themightyoarfish commented 5 months ago

Checklist

Describe the issue

Consider the code block under this paragraph for instance: https://www.open3d.org/docs/latest/tutorial/Advanced/pointcloud_outlier_removal.html#Prepare-input-data

It renders like this:

image

And most of the code is unreadable.

Steps to reproduce the bug

1. Open any page with formatted code in the latest documentation.
2. observe that you cannot read the code

Error message

No response

Expected behavior

No response

Open3D, Python and System information

- Operating system: macOS 10.15
- Browser: Firefox 126.0.1, Chrome 125.0.6422.142

Additional information

No response

saurabheights commented 5 months ago

@themightyoarfish The issue is because this is old documentation which is still located at the url

latest/tutorial/Advanced/pointcloud_outlier_removal.html#Prepare-input-data

The new path should be:- latest/tutorial/geometry/pointcloud_outlier_removal.html

The old paths were never deleted during change in paths of the documentation. Furthermore, since Open3D moved to furo theme (modern looks), I believe the CSS of the new theme is causing old docs to be rendered incorrectly.

See https://www.open3d.org/docs/latest/tutorial/geometry/pointcloud_outlier_removal.html where code is correctly rendered.

@ssheorey Tagging for action. AFAIK, this can be easily done manually.

mdfirman commented 3 months ago

Thanks for raising this issue; I've had exactly the same problem, I assumed it was some browser plugin I had breaking this. It was only when I tried the docs in other browsers and in ingocnito that I realised it was a bug in the docs themselves.

Its worth knowing that the "deprecated" versions of the docs (with the rendering bug) will often come up first in search results, at least for me. So when I use google to find documentation, a lot of the documentation I see has this issue.

image image