OSOceanAcoustics / echoregions

Interfacing water column sonar data with annotations and labels
https://echoregions.readthedocs.io/
Apache License 2.0
6 stars 6 forks source link

Update Documentation #114

Closed ctuguinay closed 1 year ago

ctuguinay commented 1 year ago

Update Documentation

This PR addresses #73 and #111:

You can view a test version of readthedocs based on a different branch on my fork called update-documentation (which is what this branch is based on). Small changes were made on this branch to accommodate the merging of this branch into main.

I may need to figure out some small details once this is merged, if any problems occur in building of the readthedocs.

Also, I do realize that the notebooks are lacking, but I think that updating the notebooks themselves and solving #106 will be better addressed in a separate PR. In that PR, I'll also add something regarding the package requirements to run the notebooks.

codecov[bot] commented 1 year ago

Codecov Report

Merging #114 (9091408) into main (3a3251b) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #114   +/-   ##
=======================================
  Coverage   75.28%   75.28%           
=======================================
  Files          13       13           
  Lines         433      433           
=======================================
  Hits          326      326           
  Misses        107      107           
Impacted Files Coverage Δ
echoregions/__init__.py 100.00% <ø> (ø)
echoregions/lines/__init__.py 100.00% <ø> (ø)
echoregions/lines/lines.py 87.95% <ø> (ø)
echoregions/lines/lines_parser.py 100.00% <ø> (ø)
echoregions/regions2d/__init__.py 100.00% <ø> (ø)
echoregions/regions2d/regions2d.py 73.29% <ø> (ø)
echoregions/regions2d/regions2d_parser.py 95.65% <ø> (ø)
echoregions/utils/__init__.py 100.00% <ø> (ø)
echoregions/utils/io.py 44.68% <ø> (ø)
setup.py 0.00% <ø> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more