search

plasmo-dev / Plasmo.jl

A Platform for Scalable Modeling and Optimization
Other
150 stars 21 forks source link

Documentation is out of date? #51

Closed odow closed 1 year ago

odow commented 2 years ago

It looks like you aren't building or updating the documentation?

Last commit to gh-pages was in 2020: https://github.com/zavalab/Plasmo.jl/tree/gh-pages

This came up in a JOSS review you might be interested in https://gitlab.uliege.be/smart_grids/public/gboml/-/issues/1

jalving commented 2 years ago

Hey @odow!

Correct, the documentation has not been updated since v0.4.0. I have been trying to clean up the code a bit, improve coverage, get the MadNLP.jl interface working, etc... I'll make a point to get the docs in good shape.

Thanks for the reference. GBOML looks really cool. I have been intending to develop a distributed optigraph interface to use DSP. It looks like they have made quite a bit progress on that front.

anhinga commented 1 year ago

I wonder if it's still the case that it's out of date; the commits in https://github.com/plasmo-dev/Plasmo.jl/tree/gh-pages seem to be recent...

The link in the README.md does seem to be wrong (it points to zavalab for documentation, instead of pointing to plasmo-dev)...

jalving commented 1 year ago

You are correct, the documentation was updated for v0.5. It just isn't as complete as it needs to be. I was planning to do a bit more before I close this issue. The doc link seems to redirect correctly, but you are right it should be updated.

Documentation ideas and enhancements are also welcome :)

odow commented 1 year ago

Docs are building again: https://plasmo-dev.github.io/Plasmo.jl/v0.5.3/