fastscape-lem / fastscapelib

A C++/Python library of efficient algorithms for landscape evolution modeling
http://fastscapelib.readthedocs.io
GNU General Public License v3.0
36 stars 6 forks source link

Improve documentation #120

Closed benbovy closed 1 year ago

benbovy commented 1 year ago

Documentation was largely outdated.

Checklist:

benbovy commented 1 year ago

@hannahsophiadavies FYI I just finished rewriting the documentation from scratch.

This pull-request is way too big to review, so I'm going to merge it and go ahead with other items in the roadmap. However, it would be great if you can have a look at it whenever you have some time. I would greatly appreciate any feedback, ideas or suggestions to improve the documentation! (this could be done in new issues)

The rendered documentation can temporarily be viewed here: https://fastscapelib--120.org.readthedocs.build/en/120/

After this PR is merged, the new documentation will be here: https://fastscapelib.readthedocs.io/en/latest/