stochasticHydroTools / libMobility

A collection of tools to compute hydrodynamic displacements.
MIT License
4 stars 0 forks source link

A readthedocs documentation #4

Closed RaulPPelaez closed 7 months ago

RaulPPelaez commented 9 months ago

The solvers in this project are mostly self-documenting (you an write help(solver)). But for discoverability it is good to have a modern documentation, see the one for UAMMD https://uammd.readthedocs.io/en/latest/ .

It is possible to autogenerate the docs from the code by using the docstrings of the different functions/classes.