BreakingBytes / simkit

Model Simulation Framework
http://breakingbytes.github.io/simkit/
BSD 3-Clause "New" or "Revised" License
27 stars 16 forks source link

Update documentation. #109

Closed veronicaguo closed 7 years ago

veronicaguo commented 7 years ago
mikofski commented 7 years ago

@veronicaguo I think we should add or update the announements on index.rst to say something about how v0.3.1 will not work without parameters, so this will break old models, they will have to migrate to use parameters.

Also add something to talk about class Meta in the announcements but also somewhere else in the docs.

And we should mention the incompatibility with the Pint v0.8.

mikofski commented 7 years ago

I think we should update the API as well with some of the new classes and auto-document them.

mikofski commented 7 years ago

@veronicaguo Thanks for making those changes. This is looking good. Let me work on it today, maybe I can wrap it up. :)

mikofski commented 7 years ago

fixes #95