OpenFreeEnergy / openfe

The Open Free Energy toolkit
https://docs.openfree.energy
MIT License
124 stars 15 forks source link

2 warnings when building docs #819

Closed mikemhenry closed 2 months ago

mikemhenry commented 2 months ago

/home/mmh/micromamba/envs/openfe-docs/lib/python3.10/site-packages/gufe/settings/models.py:docstring of gufe.settings.models.OpenMMSystemGeneratorFFSettings:1: WARNING: duplicate object description of gufe.settings.models.OpenMMSystemGeneratorFFSettings, other instance in reference/api/openmm_rfe, use :noindex: for one of them

/home/mmh/micromamba/envs/openfe-docs/lib/python3.10/site-packages/gufe/settings/models.py:docstring of gufe.settings.models.ThermoSettings:1: WARNING: duplicate object description of gufe.settings.models.ThermoSettings, other instance in reference/api/openmm_rfe, use :noindex: for one of them

It might be a local thing, but I did run make clean first

richardjgowers commented 2 months ago

@mikemhenry have you also deleted your generated/ directory? make clean doesn't do that

mikemhenry commented 2 months ago

Gah this is the second time I've been tripped up by this (I think last time the word "generated" was in the warning which was a good hint), sorry for the noise