search

simpeg / aurora

software for processing natural source electromagnetic data
MIT License
13 stars 2 forks source link

Update docs #340

Closed kujaku11 closed 1 month ago

kujaku11 commented 1 month ago

Updating the documentation, mainly the README.rst and index.rst files.

Recompiled the .rst files to the modern code architecture so that when the docs are compiled they reflect the existing code.

Updated aurora logo to be present on docs home page.

kkappler commented 1 month ago

This looks awesome! Thanks @kujaku11 This PR will also resolve the longstanding issue #194, as well as issue #336

I will review soon -- there may still be one minor change needed to make the notebooks figures correct. I'm looking into this now.

kkappler commented 1 month ago

Reviewing the warnings during docs build. Merging latest (and finished first draft) adding of doc strings from #337.