mosdef-hub / mbuild

A hierarchical, component based molecule builder
https://mbuild.mosdef.org
Other
171 stars 79 forks source link

Documentation defines build.format.charmm_writer which does not exist #1168

Closed jaclark5 closed 5 months ago

jaclark5 commented 5 months ago

Bug summary

In the stable release documentation there is a page that defines a charmm_writer module however this module does not exist in the code base.

Code to reproduce the behavior

Navigate to https://mbuild.mosdef.org/en/stable/getting_started/writers/GOMC_file_writers.html

daico007 commented 5 months ago

Hi @jaclark5, thank you for spotting that! The CHARMM writer used to be in mBuild but has now moved and being maintained here https://github.com/GOMC-WSU/MoSDeF-GOMC/blob/main/mosdef_gomc/formats/charmm_writer.py. We will work on updating the docs to remove the obsolete pages.

daico007 commented 5 months ago

Fixed by #1169 (the latest doc should be built correctly now, the stable doc will be updated in the next release).