Fix sphinx docs build issue

openmm / openmm-ml

High level API for using machine learning models in OpenMM simulations

Other

75 stars 25 forks source link

Fix sphinx docs build issue #74

Closed JMorado closed 2 months ago

JMorado commented 2 months ago

Sphinx is having trouble with the two links for MACE in the README.md file added in PR #72, which are preventing the docs from building properly. I've tested this fix on my fork, and it seems to resolve the issue.

peastman commented 2 months ago

As far as I can tell, all you changed was to move the word "implementation" into the link description? What was the problem?

JMorado commented 2 months ago

The problem was that there were two links associated with the MACE keyword: one pointing to https://arxiv.org/abs/2206.07697 and another to the repository https://github.com/ACEsuit/mace. It appears that Sphinx does not handle this well.

peastman commented 2 months ago

Ok. Thanks!