-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add MHKiT-MATLAB v0.5.0 Updates #73
Conversation
* Downgrade specific python dependencies * Update screenshots * Fix typos
@akeeste this is mostly good go, but before merging I would like to get your opinion on #74. After |
Per https://stackoverflow.com/questions/33904042/is-doctrees-folder-required-for-displaying-html-docs-with-sphinx doctrees contains a cache of rst source docs and are not needed in the repository. These files are getting large enough to trigger warnings during git push: ``` File docs/doctrees/mooring_example. doctree is 58.16 MB; this is larger than GitHub's recommended maximum file size of 50.00 MB ``` To mitigate this warning and further errors we are ignoring the `docs/doctree` and the older `docs/.doctree` folders.
This is not needed to display html. `docs/.doctrees` seems to be an artifact from an ~4 year old build of the mhkit documentation. This folder is dynamically created during a build and is not necessary to save to the commit history.
Per https://stackoverflow.com/questions/33904042/is-doctrees-folder-required-for-displaying-html-docs-with-sphinx doctrees contains a cache of rst source docs and are not needed in the repository. These files are getting large enough to trigger warnings during git push: ``` File docs/doctrees/mooring_example. doctree is 58.16 MB; this is larger than GitHub's recommended maximum file size of 50.00 MB ``` To mitigate this warning and further errors we are ignoring the `docs/doctree` and the older `docs/.doctree` folders.
37037a1
to
d48e0c3
Compare
This PR includes the following from MHKiT-MATLAB v.05.0:
Updated MHKiT-MATLAB submodule
New Livescripts:
API Documentation
Installation
pip install numpy~=1.24.0 scipy~=1.10.0 netcdf4~=1.6.0
Other changes:
doctree
files are causing a warning ongit push
#74 by:docs/.doctrees
&docs/doctrees
folders c4834ef.docs/doctrees
6b48ed7.docs/.doctrees
9993f6e