create Read the Docs

[wang-boyu]

This PR:

• creates documents in the docs folder for Read the Docs
• updates the docstrings accordingly

It'll look like mesa-geo.readthedocs.io. Currently it points to my forked repo, but I'll update the settings once this PR is merged. Plus, some links may not work until then.

[codecov]

Codecov Report

Base: 79.90% // Head: 79.90% // No change to project coverage 👍

Coverage data is based on head (2009d9a) compared to base (8d779e9).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #99   +/-   ##
=======================================
  Coverage   79.90%   79.90%           
=======================================
  Files           7        7           
  Lines         622      622           
  Branches      108      108           
=======================================
  Hits          497      497           
  Misses        108      108           
  Partials       17       17           

Impacted Files	Coverage Δ
mesa_geo/geo_base.py	76.92% <ø> (ø)
mesa_geo/geoagent.py	78.94% <ø> (ø)
mesa_geo/geospace.py	85.39% <100.00%> (ø)
mesa_geo/raster_layers.py	73.92% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[rht]

Since the README.md is in Markdown and it renders properly, does that mean the rest of the automodule files can be in Markdown too?

[wang-boyu]

Since the README.md is in Markdown and it renders properly, does that mean the rest of the automodule files can be in Markdown too?

Well I would love to, but it appears that autodoc doesn't work well with Markdown yet. See the warning from this page:

This expects docstrings to be written in reStructuredText. We hope to support Markdown in the future, see GitHub issue #228.