MDAnalysis / mdaencore

Ensemble overlap comparison software for molecular data.
http://www.mdanalysis.org/mdaencore/
GNU General Public License v2.0
0 stars 0 forks source link

[DOCS] links to functions/classes are non-existent #43

Closed orbeckst closed 12 months ago

orbeckst commented 1 year ago

Expected behavior

When digging through the API docs I should be able to get to a full documentation of classes and functions.

Actual behavior

Clicking any class name in a summary table such as bootstrapped_matrix in https://www.mdanalysis.org/mdaencore/autosummary/mdaencore.bootstrap.html#module-mdaencore.bootstrap , which is styled as a link, fails to go anywhere: there's no underlying link.

Code to reproduce the behavior

E.g. https://www.mdanalysis.org/mdaencore/autosummary/mdaencore.bootstrap.html#module-mdaencore.bootstrap and click any of the orange links in the table:

image

However, this is true for most links.

For a few classes, such as mdaencore.clustering.ClusterCollection the links resolve but then the links for the Methods are not present.

Current environment

orbeckst commented 1 year ago

@ianmkenney is there something in the sphinx autosummary settings that can be changed so that at least all the functions, classes and methods have content generated? Or does this require actually building docs so that these parts resolve?

As it stands, the docs are not really usable at the moment so this needs fixing.