search

thesketh / pygen-structures

3D molecular structure generation for MD simulation
https://pygen-structures.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
9 stars 3 forks source link

Documentation needs more examples #2

Open thesketh opened 4 years ago

thesketh commented 4 years ago

At present, the ReadTheDocs documentation is somewhat limited. It contains the function/class signatures, but no examples of using the code.

There are examples in the README which cover the most basic use, but these could be expanded upon for more complex examples.

thesketh commented 4 years ago

More examples added for command line usage in 79b3265580f37aa62d4fd07c393721bb1d6899e6, still need to add examples for library usage. Examples need to be added to RtD documentation.