GitHub Community
Possible regression: failed rendering of ReStructuredText files #86715
Replies: 38 comments 77 replies
-
|
Simple .rst files seem to work fine, so I guess we're just hitting some new complexity limit... |
Beta Was this translation helpful? Give feedback.
-
|
This one does not render any more, either: https://github.com/mikf/gallery-dl/blob/master/docs/configuration.rst |
Beta Was this translation helpful? Give feedback.
-
|
At our end I've pinned it down to one patch that takes the file from rendering -> failing: https://github.com/Materials-Consortia/OPTIMADE/blob/450f5e4b22d044b30104784ff12bd8e3878c5470/optimade.rst vs https://github.com/Materials-Consortia/OPTIMADE/blob/b177978945e5755e9fbebb33557eec79be3e8746/optimade.rst (details in this PR Materials-Consortia/OPTIMADE#493) |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
I'm also getting Unicorn error messages (This page is taking too long to load. / Sorry about that. Please try refreshing and contact us if the problem persists.) sometimes, and sometimes the raw RST file.
|
Beta Was this translation helpful? Give feedback.
-
|
Adding to this, the following are no longer even viewable (not getting the unicorn, getting error, something went wrong): |
Beta Was this translation helpful? Give feedback.
-
|
I've filed this under ticket |
Beta Was this translation helpful? Give feedback.
-
|
I had a similar reply as the above on 17th Jan but no follow-up yet:
|
Beta Was this translation helpful? Give feedback.
-
|
Have y'all gotten any further engagement from GitHub (other than the initial canned/robot response in January)? 👀 |
Beta Was this translation helpful? Give feedback.
-
|
Yes, there was https://github.com/orgs/community/discussions/86715#discussioncomment-8431598 in beginning of February, which wasn't very helpful, and https://github.com/orgs/community/discussions/86715#discussioncomment-9149558 in April, where actually something happened and it got a lot better. There are still a lot of broken things, but at least there's a rendering preview again that renders many things correctly (albeight still many not correctly or at all). |
Beta Was this translation helpful? Give feedback.
-
I'm confused about this actually. Rendering RST is not a new feature, it worked totally fine before. Did GitHub just change their rendering engine to a different one without any testing? And even if so, why not switch it back to the old one at least before the new one is good enough in internal testings? |
Beta Was this translation helpful? Give feedback.
-
|
I agree, but having rendered some is still better than having rendered nothing - which was the situation between early January and ... not sure anymore, but months later. I'm also very much interested in an answer to the later question, but I guess we won't get any... |
Beta Was this translation helpful? Give feedback.
-
|
We are experiencing similar issues with Colour since a few days? (Unsure when it started exactly) Our README which was rendering fine has stopped rendering: https://github.com/colour-science/colour. We are also using reStructuredText! |
Beta Was this translation helpful? Give feedback.
-
|
Rendering is failing on all of our files above 1500-ish lines. There is noticeable lag and then the raw version is displayed. It breaks somewhere between 1000 and 1600 lines. |
Beta Was this translation helpful? Give feedback.
-
|
This should be a high priority to fix. https://github.com/HumanCellAtlas/dcp2/blob/main/docs/dcp2_system_design.rst 
Note that the Preview tab is active in the above screenshot but the display is as if the Code tab were active. |
Beta Was this translation helpful? Give feedback.
-
|
See also https://github.com/orgs/community/discussions/86715#discussioncomment-8434630 |
Beta Was this translation helpful? Give feedback.
-
|
GitHub support responded
|
Beta Was this translation helpful? Give feedback.
-
|
Seems like a file size issue to me more than time-out. I did some experimentation, and eventually pinpointed the exact character on which the page would fail: stuij/abi-aa@605b80b For this document, this came down to 62804 characters or 62892 bytes. Reliably. If it'd be render time, i'd expect at least a bit of variation from render to render. |
Beta Was this translation helpful? Give feedback.
-
|
@gundalow : where did you file that ticket? Because I think it's clear that the reason they gave isn't applicable to the issue that some of us here are seeing. I'd like to try and put in another ticket. |
Beta Was this translation helpful? Give feedback.
-
|
@stuij Thanks for this extra info, that's useful troubleshooting info. I've passed it on to GitHub Support. I'll reply to this thread once I hear more. |
Beta Was this translation helpful? Give feedback.
-
|
If it is a file size problem, it's not really deterministic either. The file that works from my gist has 52654 bytes, the file that does not has 52687 bytes. Maybe it is a count of something else? |
Beta Was this translation helpful? Give feedback.
-
|
How are you? If I delete this, will my site crash, or is this just for search engines? /next-sitemap.config.js Sorry, I am just in a little bit of bind, Google My business does not like something on it, and they emailed me about fixing it. Thanks! |
Beta Was this translation helpful? Give feedback.
-
|
The reply I got from Github Support when I created a ticket on this: |
Beta Was this translation helpful? Give feedback.
-
|
I hope they'll fix that soon. I'm also affected by this. I have a large file with several reStructuredText markup feature used and it was rendering fine: https://github.com/pierre-rouleau/pel/blob/master/doc/pel-manual.rst |
Beta Was this translation helpful? Give feedback.
-
|
My document now renders... but sections lost their numbers. The table of content is only visible on the right side, in the Outline pane. |
Beta Was this translation helpful? Give feedback.
-
|
One nice feature of the Outline pane is the ability to filter their section titles. |
Beta Was this translation helpful? Give feedback.
-
|
The reStructuredText markup file here is not being rendered properly. |
Beta Was this translation helpful? Give feedback.
-
|
All of our .rst documents are now rendering again in the browser :D I spot-checked some of the broken documents in this thread, and they also render again. Hurray! |
Beta Was this translation helpful? Give feedback.
-
|
That's a huge improvement indeed! Unfortunately not all is well yet:
|
Beta Was this translation helpful? Give feedback.
-
|
Same here! I am also having code lines wrapped in |
Beta Was this translation helpful? Give feedback.
-
|
Thanks, I've passed this on to GitHub support. |
Beta Was this translation helpful? Give feedback.
-
|
Definitely an improvement, everything at https://github.com/Materials-Consortia/OPTIMADE/blob/develop/optimade.rst is working again, except the table of contents... |
Beta Was this translation helpful? Give feedback.
-
|
I also noticed that for lack of a better word sub-tables don't render anymore. So added columns or rows in a subsection of a table. For example look at the source for the Fundamental Data Types table below: This used to render like the equivalent ascii, and looks correctly in the genrated PDF: However currently you can clearly see that the table isn't parsed correctly when rendered on Github: I created a bug-report for it. |
Beta Was this translation helpful? Give feedback.
-
|
Related discussion about the underlined code issues people in here have mentioned: Code blocks appear as (underlined) links |
Beta Was this translation helpful? Give feedback.
-
|
Same problems here, previously nicely rendered README.rst broken: https://github.com/FalseNegativeLab/mlscorecheck Is this discussion visible to GitHub developers? |
Beta Was this translation helpful? Give feedback.
-
Not sure. I think mentioning this issue on Twitter or Mastodon with the appropriate tags might have more impact than doing a me-too here. |
Beta Was this translation helpful? Give feedback.
-
|
several of us have opened tickets, which unfortunately only seem to be
visible between Github and the person oening the ticket.
In my case they answered that internally they are aware and that they are
looking into it. After which at least my customer tickets get closed.
…On Sun, 14 Apr 2024 at 10:17, György Kovács ***@***.***> wrote:
Same problems here, previously nicely rendered README.rst broken:
https://github.com/FalseNegativeLab/mlscorecheck
Is this discussion visible to GitHub developers?
—
Reply to this email directly, view it on GitHub
<#86715 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AABO6NLRIUV3M6ZDBWYLZSTY5JCTJAVCNFSM6AAAAABBYIXV4GVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TCMBYGI2DM>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Beta Was this translation helpful? Give feedback.
-
|
I think the main takeaway (at least for me) is: if you want something rendered on GitHub, stick to MarkDown. Everything else can break at any moment, and then it can take month to get fixed - if ever. (I'm still waiting to be convinced that this isn't true, but... :( ) |
Beta Was this translation helpful? Give feedback.
-
|
Lets I try to guess: there is so big security hole at github because of .. code-block:: , that maybe we have never see fix for ReStructuredText. |
Beta Was this translation helpful? Give feedback.
-
|
How are you? If I delete this, will my site crash, or is this just for search engines? /next-sitemap.config.js Sorry, I am just in a little bit of bind, Google My business does not like something on it, and they emailed me about fixing it. Thanks! |
Beta Was this translation helpful? Give feedback.
-
|
@RealEstateSaga I have no idia about it |
Beta Was this translation helpful? Give feedback.
-
|
Code blocks are now rendering correctly for me although there are still some things out of whack |
Beta Was this translation helpful? Give feedback.
-
|
Code blocks also seem to be working for me too, e.g. |
Beta Was this translation helpful? Give feedback.
-
|
Hi, If you have specific examples of what's still not rendering correctly, can you please reply to this message with a URL and a short description of the rendering bug. Thanks |
Beta Was this translation helpful? Give feedback.
-
|
For example: .. pull-quote::
[!IMPORTANT]
This is important |
Beta Was this translation helpful? Give feedback.
-
|
Tables with merged cells cannot be rendered: But Sphinx can render them propery: |
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
@gundalow |
Beta Was this translation helpful? Give feedback.
-
|
@gundalow side-by-side figures are still not rendering correctly: https://github.com/HofstadterTools/HofstadterTools For reference, side-by-side figures in the corresponding sphinx docs are correct: https://hofstadter.tools/overview.html This used to work fine until fairly recently. |
Beta Was this translation helpful? Give feedback.
-
|
I noticed the same issue with our repository: https://github.com/tensorly/tensorly/edit/main/README.rst |
Beta Was this translation helpful? Give feedback.
-
|
https://github.com/bazelbuild/bazel-gazelle/blob/master/README.rst is broken on GitHub, but renders perfectly well elsewhere, e.g. in this Online reStructuredText editor |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
the image directive is still broken, it creates line breaks where it shouldn't. |
Beta Was this translation helpful? Give feedback.
-
|
Related: |
Beta Was this translation helpful? Give feedback.
-
|
This bug/regression persists. |
Beta Was this translation helpful? Give feedback.
-
|
This bug persists. |
Beta Was this translation helpful? Give feedback.
-
|
Bug persists. |
Beta Was this translation helpful? Give feedback.
-
|
Looks like some problems have recently been fixed. The list of tags at the top of my pages where recently sowing on separate lines. Now, they show one after the other, as they used to show. So...Good! Some improvements! All hope is not lost! |
Beta Was this translation helpful? Give feedback.
-
|
Seeing a proper rendering of https://github.com/bazelbuild/bazel-gazelle/blob/master/README.rst now too! |
Beta Was this translation helpful? Give feedback.
-
|
Hey, my table of contents is working again! 🙏🏼 |
Beta Was this translation helpful? Give feedback.
-
|
My images are now showing side-by-side in the readme, which is how it should be! 😃 https://github.com/HofstadterTools/HofstadterTools?tab=readme-ov-file#quick-start |
Beta Was this translation helpful? Give feedback.
-
|
Python console code blocks render correctly again! Yay! https://github.com/zopefoundation/z3c.form/tree/master/src/z3c/form/browser#browser-support |
Beta Was this translation helpful? Give feedback.
-
|
My rST README is rendered as it was before the bug! 🎉 |
Beta Was this translation helpful? Give feedback.
-
|
No one seems to mention that so far: is the root cause of all these due to GitHub switched from using There was a rendering issue I discussed above (https://github.com/orgs/community/discussions/86715#discussioncomment-9149986) and I later reported to pandoc (jgm/pandoc#9805) since they had the same issue. After the dev of pandoc fixed it, it was fixed on GitHub's end too now. |
Beta Was this translation helpful? Give feedback.
-
|
Good find, that does seem likely to be the root cause |
Beta Was this translation helpful? Give feedback.
-
|
I don't think they ever used Sphinx. They did use docutils (which Sphinx also uses) though: https://github.com/github/markup/blob/master/lib/github/commands/rest2html - but apparently they stopped using that script at the beginning of this year. (Or even before. That repo looks like it hasn't really been maintained for a longer time...) |
Beta Was this translation helpful? Give feedback.
-
|
It's working fine for me now. Thanks for fixing this!! |
Beta Was this translation helpful? Give feedback.
-
|
🕒 Discussion Activity Reminder 🕒 This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions: 1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as 2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own. 3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution. Note: This dormant notification will only apply to Discussions with the Thank you for helping bring this Discussion to a resolution! 💬 |
Beta Was this translation helpful? Give feedback.
and others
-
Select Topic Area
Question
Body
Hi, we have a technical specification hosted on GitHub that makes heavy use of ReStructuredText (https://github.com/Materials-Consortia/OPTIMADE/blob/develop/optimade.rst). Up until today, our specification was nicely rendered when people viewed it on GitHub, but now we only have the option to view the raw files. Is this a global change, a bug, or something specific to our file (rendering timeouts perhaps)?
Thanks!
EDIT: please see many other examples below. In our case we could isolate the changes which cause the specification not to render (simply seems to arise from document length rather than any particular rst feature, see https://github.com/orgs/community/discussions/86715#discussioncomment-8117857)
Beta Was this translation helpful? Give feedback.
All reactions