search

SNL-WaterPower / WecOptTool-MATLAB

WEC Design Optimization Toolbox
GNU General Public License v3.0
12 stars 9 forks source link

Automatic Docs Build on Master Commit #72

Closed H0R5E closed 4 years ago

H0R5E commented 4 years ago

As the online docs rely on the source code for various elements, automated rebuild of the documentation when commits are made to the master branch would be useful. We would need to engage a CI tool such as Jenkins to implement this.

ssolson commented 4 years ago

I know Zack set up a dedicated computer with a MATLAB license to do CI for WEC-SIM. @zmorrell-sand can you relay your experience doing this with Sandia/ WEC-SIM?

@H0R5E are you only suggesting that we rebuild documentation using sphinx? In which case we did that with MHKIT.

H0R5E commented 4 years ago

Yes, we would just need to run Sphinx, which we could do on a remote service.

We could use a local machine to automatically run the tests, which would be useful. It's probably another issue though, if you'd like to start one.

H0R5E commented 4 years ago

Closed by #119.