search

OpenMS / pyopenms-docs

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

Make index more prominent #263

Closed jpfeuffer closed 2 years ago

jpfeuffer commented 2 years ago

Currently it is only reachable by scrolling down on the home page of the documentation I think. https://pyopenms.readthedocs.io/en/latest/index.html#indices-and-tables

which leads to: https://pyopenms.readthedocs.io/en/latest/genindex.html

jpfeuffer commented 2 years ago

The api doc is now reachable with https://pyopenms.readthedocs.io/en/latest/apidoc.html But maybe and index is also worthwhile. Maybe we should remove functions from the index and only display classes. Or create a separate index for API docs and the rest of the documentation. Or split API doc and high-level doc completely?

tapaswenipathak commented 2 years ago

Where do you think index would be better placed?

jpfeuffer commented 2 years ago

It is available under apidoc with a title in the Sidebar by now.