Update README and docs index page, fix RTD build and setup

OSOceanAcoustics / echoregions

Interfacing water column sonar data with annotations and labels

https://echoregions.readthedocs.io/

Apache License 2.0

6 stars 5 forks source link

Update README and docs index page, fix RTD build and setup #179

Closed leewujung closed 4 months ago

leewujung commented 4 months ago

The updates include:

new sections: intro, acknowledgements, contributors in README
license info in README
use most of README for the new docs/index.md
fix mismatching rtd and package setup
remove unneeded extra packages in setup.cfg

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.80%. Comparing base (e205f7a) to head (00f359c). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #179 +/- ## ======================================= Coverage 87.80% 87.80% ======================================= Files 13 13 Lines 582 582 ======================================= Hits 511 511 Misses 71 71 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

leewujung commented 4 months ago

I just turned on the RTD building PR option, and closed-reopened this PR to trigger that.

leewujung commented 4 months ago

Oops something is happening with the python version in RTD build. I'll look into that this evening.

leewujung commented 4 months ago

Hey @ctuguinay : I think I'll self-merge this so that we have the updated README and docs/index page, especially since there's no code change.

Note that I changed quite a bit of setup stuff for RTD build to go through and removed some unnecessary items that seemed to be from echopype.