#1669 render README in Pagure
Closed: Fixed 2 years ago by mikem. Opened 3 years ago by ktdreyer.

For some reason Pagure does not render the Sphinx in README.rst as HTML on the home page of https://pagure.io/fm-orchestrator. It just shows the plaintext intead.


Pagure cannot render this line:

_`Client tooling`

This appears to be a regression in Pagure. The README.rst was rendering fine last September.

https://web.archive.org/web/20200926144700/https://pagure.io/fm-orchestrator/
(this is at commit 29c49dc)

But a week or so later, it stopped
https://web.archive.org/web/20201021165837/https://pagure.io/fm-orchestrator
(this is at commit 36ca6c6)

There are no changes in README.rst between these two commits. If I roll my fork back to the older of the two, README continues to be unrendered.

Same issue affects several files under docs/

I dug into this and was able to get it to render after the following adjustments:

First -- removing the LICENSE substitution link

I'm not sure why this is throwing pagure off. It matches the form of the others, but differs in that the file is in the root of the repo instead of under docs.

Second -- removing references to section titles

Again, not sure why pagure can't handle these when it did before, but removing explicit links works around

Third -- removing the duplicate substitution for CONTRIBUTING link

This part the file actually had wrong. The tortuous link scheme that we're using relies on defining substitutions and we didn't need a duplicate definition. Presumably this causes a rendering error for pagure.

PR #1707 fixes the readme rendering, though not the other files under docs/

Filed #1710 for the other two files

Login to comment on this ticket.

Metadata
Related Pull Requests
  • #1710 Merged 2 years ago
  • #1707 Merged 2 years ago