torchmd / torchmd-net

Training neural network potentials
MIT License
335 stars 75 forks source link

Improve documentation #224

Closed RaulPPelaez closed 1 year ago

RaulPPelaez commented 1 year ago
RaulPPelaez commented 1 year ago

I went ahead and started integrating a Sphinx documentation to publish it in https://docs.readthedocs.io/en/stable/ Luckily, this being a python project makes it possible to easily autogenerate most of it from the docstrings. Alas, it requires being careful with the docstring format so sphinx understands it.

Thus far I have a component tree: image And doc pages for some of the main classes/functions, which look like this: image

RaulPPelaez commented 1 year ago

This is ready to merge. @guillemsimeon @AntonioMirarchi @raimis @giadefa Any comments about how the docs are set up now? The docs in this PR are (and will be) hosted here https://torchmd-net.readthedocs.io

If you are ok with it please review/approve the PR so I can merge. In any case comments/suggestion are appreciated.