search

symfony-tools / docs-builder

MIT License
28 stars 22 forks source link

Weird html escape with invalid link reference #171

Open danielburger1337 opened 9 months ago

danielburger1337 commented 9 months ago

First off, I'm not quite sure what the underlying issue is (and even it is one) and whether this is an upstream issue with the RST-parser or not:

I was looking at the scheb/2fa-bundle documentation to see whether the updated docs are live yet and saw that an added link to packagist.org wasn't correctly displayed. Looking at the html-markup revealed the following (see image):

Screenshot_20240206_235808

The RST-source file was missing a space between the link and the text. PR to fix that has been made.

# original
`related packages on Packagist.org<https://packagist.org/packages/scheb/2fa-bundle/dependents>`_.
# fixed 
`related packages on Packagist.org <https://packagist.org/packages/scheb/2fa-bundle/dependents>`_.

Is it intended behavior to be able to embed html elements like that? To me it looks like there is some sort of escaping going on since the slashes have been removed from the html-source and the escaping might have failed?

homersimpsons commented 3 months ago

I think this issue can be closed as https://github.com/scheb/2fa/pull/220 is merged.

Edit: I wrngly interpreted the pull request.

stof commented 2 months ago

It looks like doctrine/rst-parser does not properly escapes the content of the link text (and the whole related packages on Packagist.org<https://packagist.org/packages/scheb/2fa-bundle/dependents> gets parsed as the link text, which is expected according to the spec)