OpenMS / pyopenms-docs

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

link to pxd files so users can easier look up all wrapped methods #107

Closed timosachsenberg closed 1 year ago

timosachsenberg commented 3 years ago

e.g., put a link like "See all wrapped method definitions."

timosachsenberg commented 3 years ago

or find a better way (e.g., via sphinx)

oliveralka commented 3 years ago

Maybe e.g. https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html

jpfeuffer commented 3 years ago

Problem: pxds need to be available first. -> We need CI that pushes a fresh pyopenms wheel whenever there are updates.

timosachsenberg commented 3 years ago

some code I found in similar context but for latex: https://github.com/OpenMS/OpenMS/tree/develop/src/pyOpenMS/doc

tapaswenipathak commented 2 years ago

Can this be done rn?

timosachsenberg commented 2 years ago

let's move this a bit down the priority list

jpfeuffer commented 2 years ago

We have a barebones apidoc now. I agree on low priority

timosachsenberg commented 1 year ago

solved via api