Add MHKiT-MATLAB v0.5.0 Updates #73
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* 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.
simmsa
force-pushed
the
mhkit-matlab-v0.5.0
branch
from
37037a1
to
d48e0c3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.0Other changes:
doctreefiles are causing a warning ongit push#74 by:docs/.doctrees&docs/doctreesfolders c4834ef.docs/doctrees6b48ed7.docs/.doctrees9993f6e