Reference in markdown documentation is not being rendered in HTML #5966

Closed
opened 2026-01-22 15:23:33 +01:00 by admin · 3 comments
Owner

Originally created by @holtkamp on GitHub (May 18, 2018).

In the documentation about Events, the following snippet is used:

:ref:`reference-events-implementing-listeners`

Not sure how to refer to lines in a .md file, so here is a screenshot:

screen shot 2018-05-19 at 00 03 40

It seems that when being rendered on https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html#lifecycle-events (the last block), no hyperlink is rendered..., again a screenshot:

screen shot 2018-05-18 at 23 58 50

Maybe I am missing something, but it seems during the compilation / build of the documentation this reference is not detected / respected?

Originally created by @holtkamp on GitHub (May 18, 2018). In the documentation about [Events](https://github.com/doctrine/doctrine2/blob/master/docs/en/reference/events.rst), the following snippet is used: ``` :ref:`reference-events-implementing-listeners` ``` Not sure how to refer to lines in a .md file, so here is a screenshot: <img width="710" alt="screen shot 2018-05-19 at 00 03 40" src="https://user-images.githubusercontent.com/776405/40259841-1df3d7d4-5af8-11e8-9da7-5bafe45add3c.png"> It seems that when being rendered on https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html#lifecycle-events (the last block), no hyperlink is rendered..., again a screenshot: <img width="918" alt="screen shot 2018-05-18 at 23 58 50" src="https://user-images.githubusercontent.com/776405/40259832-0e02602a-5af8-11e8-83f4-78febc86b68d.png"> Maybe I am missing something, but it seems during the compilation / build of the documentation this reference is not detected / respected?
admin closed this issue 2026-01-22 15:23:34 +01:00
Author
Owner

@jwage commented on GitHub (May 19, 2018):

There is no rst file named reference-events-implementing-listeners.rst in the docs folder that I could find. This might be a case of a file being renamed or removed and a reference wasn't updated.

@jwage commented on GitHub (May 19, 2018): There is no rst file named `reference-events-implementing-listeners.rst` in the docs folder that I could find. This might be a case of a file being renamed or removed and a reference wasn't updated.
Author
Owner

@holtkamp commented on GitHub (May 19, 2018):

So probably this section is referred to? https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html#implementing-event-listeners

@holtkamp commented on GitHub (May 19, 2018): So probably this section is referred to? https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html#implementing-event-listeners
Author
Owner

@holtkamp commented on GitHub (Aug 6, 2019):

This seems now resolved => close issue.

Screenshot 2019-08-06 at 15 53 43

@holtkamp commented on GitHub (Aug 6, 2019): This seems now resolved => close issue. ![Screenshot 2019-08-06 at 15 53 43](https://user-images.githubusercontent.com/776405/62545686-7a51d580-b862-11e9-81c5-f00d6f28349e.png)
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: doctrine/archived-orm#5966