OpenMS / pyopenms-docs

pyOpenMS readthedocs documentation, additional utilities, addons, scripts, and examples.
https://pyopenms.readthedocs.io
Other
43 stars 50 forks source link

Escape underscores and other special sphinx characters #306

Open jpfeuffer opened 1 year ago

jpfeuffer commented 1 year ago

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.

rahul799 commented 1 year ago

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

jpfeuffer commented 1 year ago

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.

rahul799 commented 1 year ago

Got it. I will check

jpfeuffer commented 1 year ago

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

timosachsenberg commented 1 year ago

not all fixed