search

OpenMS / pyopenms-docs

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

Do not Index function names #262

Closed jpfeuffer closed 2 years ago

jpfeuffer commented 2 years ago

We have recently added apidocs under apidocs rst. Unfortunately it adds everything to the index. I think functions are maybe not needed there. But I don't know how to pass :noindex: to autosummary such that autodoc uses it for functions.

tapaswenipathak commented 2 years ago

Can you write one example?

jpfeuffer commented 2 years ago

I think I improved on that by making the apidoc hierarchical. First modules, then classes, then methods. As separate pages. Works ok for now.