Add type annotations, docstrings and documentation

geoelements / diffmpm

Differentiable Material Point Method

29 stars 6 forks source link

Add type annotations, docstrings and documentation #23

Closed chahak13 closed 1 year ago

chahak13 commented 1 year ago

Closes #20

chahak13 commented 1 year ago

I'm currently using pdoc3 for the link that I shared but I'm not sure if we want to continue using that or move to sphinx maybe. But yes, will definitely want to add that workflow. Maybe can make that as another PR and get that in for now?