search

TopoToolbox / pytopotoolbox

Python interface to TopoToolbox
https://topotoolbox.github.io/pytopotoolbox/
GNU General Public License v3.0
1 stars 2 forks source link

Refactor package #39

Closed Teschl closed 1 month ago

Teschl commented 1 month ago

I refactored the package, so the locations of different functions make more sense. The functions creating a GridObject are now in utils.py, and calling topotoolbox.GridObject() will result in an empty GridObject.

I also changed the way autosummary is used, so the way the functions are listed reflects the way they are used. Instead of having topotoolbox.utils.load_dem() in the documentation, it's now topotoolbox.load_dem() for example. The docstrings are now in the numpy format instead of the Google one, this keeps readability while insuring they are formatted right in the documentation.

closes #34

Teschl commented 1 month ago

@wkearn I added 'clean' to the makefile, overwriting the Sphinx version. It now cleans _build, _examples and _autosummary. After building, the _autosummary directory will get cleaned as well.