search

earth-chris / earthlib-legacy

Spectral endmembers and unmixing tools for satellite land cover mapping.
https://earth-chris.github.io/earthlib
MIT License
24 stars 3 forks source link

deepclean #23

Closed earth-chris closed 3 years ago

earth-chris commented 3 years ago

This PR deleted a bunch of files, reorganized others, and refactored the rest. The legacy folder was pushed to CBA's google drive account. The code refactoring focused on writing blank docstrings then converting all docstrings to google-style docstrings.

Module import behavior was updated to only import at the top of any submodule (no more within-function imports). Code was generally scrubbed for basic hygiene.

I did not perform a complete refactor on old / brittle code. That can be addressed as we develop testing or break old features.

Resolves #22

earth-chris commented 3 years ago

This PR now also includes a mkdocs-material config and a new GitHub Action to auto build and deploy docs on pushing to the main branch.