search

OpenMS / pyopenms-docs

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

Overwritten/aliased classes not documented correctly #326

Closed jpfeuffer closed 1 year ago

jpfeuffer commented 1 year ago

Describe the problem you encountered See MSExperiment. It is aliased by MSExperimentDF from _dataframes and then overwritten.

See https://stackoverflow.com/questions/38765577/overriding-sphinx-autodoc-alias-of-for-import-of-private-class and the linked https://github.com/slundberg/shap/blob/6af9e1008702fb0fab939bf2154bbf93dfe84a16/docs/conf.py#L380-L394

on how to fix this.

timosachsenberg commented 1 year ago

@matteopilz would be great if you could fix it our check-out and report some details

timosachsenberg commented 1 year ago

@jpfeuffer I guess this is still relevant if you do the cython stuff

jpfeuffer commented 1 year ago

No, if you are not monkey-patching stuff in pure python anymore, it won't be needed.

timosachsenberg commented 1 year ago

k then let's close this for now