pyopenms-docs icon indicating copy to clipboard operation
pyopenms-docs copied to clipboard

Escape underscores and other special sphinx characters

Open jpfeuffer opened this issue 3 years ago • 5 comments

see e.g. https://github.com/OpenMS/OpenMS/commit/4e41abd4a49052549aa9f4547fb8ed1bd534b14d

Where in_ would lead to invalid target errors. This needs to be done in all "*.pyx" files in the OpenMS/OpenMS repository. Not sure if there are more cases but someone needs to check.

jpfeuffer avatar Oct 21 '22 11:10 jpfeuffer

Hey @jpfeuffer, I need more context for the issue. Can you please elaborate or we can discuss this in the weekly meet?

rahul799 avatar Oct 26 '22 15:10 rahul799

https://stackoverflow.com/questions/64068220/prevent-term-ending-in-an-underscore-from-appearing-as-hyperlink-in-sphinx-docs

Basically make sure everything is rendered properly, even if there are special characters in the variable name.

jpfeuffer avatar Oct 26 '22 15:10 jpfeuffer

Got it. I will check

rahul799 avatar Oct 26 '22 15:10 rahul799

Might be fixed by the linked PR. We need to check if this is fixed in the logs.

jpfeuffer avatar Dec 07 '22 10:12 jpfeuffer

not all fixed

timosachsenberg avatar Mar 29 '23 09:03 timosachsenberg