RST file rendering problem

[highfi13g]

Why are you seeing this issue?

This is a support escalation! You can find out more about expectations on communications and response times in the on-call docs. Thank you for doing your part to keep GitHub customers happy!

Severity

Note, for Sev1 issues always page the team first, using the PagerDuty information in the service catalog and the command .pager trigger <rotation> <reason>. Opening an issue for a Sev2 incident can come later (and can be done by the available Escalation Engineer).

• [ ] sev1 - Engineering must respond, when paged, within their on-call SLO
• [ ] sev2 - Engineering must respond to this issue within one business day
• [x] sev3 - EPD squad for the team must respond to this issue within one week

Service

markup

Issue

From the customer,

Recently, user "beauremus" reported a problem with Restructured text documents failing to render properly in the github web interface. That is, the document had rendered properly in the past, and then stopped rendering. I was the owner/creator of the problem document in that incident, and I thought that the issue was resolved. However, I do see another issue with RST file rendering that is still occurring: the RST ".. contents::" directive is not being handled correctly.

That directive should cause a table of contents to be generated. This feature worked some time ago, before the problems that were reported in the previous ticket by beauremus.

Attached is a small RST example doc that should have a TOC at the beginning of the document. In other RST rendering software, the TOC is displayed, but on the github web interface, the TOC is not displayed. There appears to be a problem handing the ".. contents::" RST directive.

[toc_test.zip](https://github.com/user-attachments/files/15926867/toc_test.zip)

**Customer Impact**

- Include information about customer impact, including which key/strategic customers are impacted.

- Include org/repo/user information for this issue where possible.
The document in question is in the "fermi-ad/postgresql" repository. I only have one document that uses the "..contents::" directive, so at this time, there's only one example I know of.

- Link to Zendesk Ticket(s) :
https://github.zendesk.com/agent/tickets/2810398

**GitHub Product(s) Impacted (check appropriate boxes and provide GHES version if applicable)**

- [x] GitHub.com (including GHEC)
- [ ] GitHub Enterprise Server.
      If GHES, please list the version of GHES the customer is on here:
- [ ] Proxima (ghe.com)
      If Proxima, please list the customer tenant:

**To Reproduce**

Steps to reproduce the behavior:

1. Refresh the problem document page to cause it to re-render.
2. Go into edit mode to edit the doc
3. Select the "Preview" tab to cause the doc to render

**Expected behavior**

A clear and concise description of what you expected to happen.

**Screenshots**

If applicable, add screenshots to help explain your problem.

**Additional context**

Attached is a Firefox HAR file of the problem document.
 
[redacted_github.com_Archive \[24-05-31 08-47-02\].zip](https://github.com/user-attachments/files/15926840/redacted_github.com_Archive.24-05-31.08-47-02.zip)



cc:
@github/open-source
@product_manager

**Support Squad(s)**: @github/support-squad-