taichi-dev / taichi_elements

High-performance multi-material continuum physics engine in Taichi
MIT License
483 stars 69 forks source link

Basic docs #21

Closed yuanming-hu closed 4 years ago

yuanming-hu commented 4 years ago

(#15) After merging this I'll host the documentation on https://readthedocs.org/

PavelBlend commented 4 years ago

OK. I looked at the commits. I really don’t understand this, so I can’t help. I have never worked with documentation. I can only edit rst files. I will write documentation on the nodes.

yuanming-hu commented 4 years ago

No problem at all. I'll go ahead and merge these in. Thanks!

yuanming-hu commented 4 years ago

Here it is: https://taichi-elements.readthedocs.io/en/latest/

I'm setting up a trigger so that it will automatically stay up-to-date...

If you want to build locally, see this: https://github.com/taichi-dev/taichi_elements/blob/master/docs/README.md