search

mantle-convection-constrained / terratools

Tools to read, analyse and visualise models written by the TERRA mantle convection code
https://terratools.readthedocs.io/en/latest/
MIT License
6 stars 5 forks source link

Add overview page about TerraModel to docs and build examples #112

Closed anowacki closed 9 months ago

anowacki commented 10 months ago

This is a stab at an overview page for TerraModel which introduces some of the conventions and lists some of the functionality. If there are other things which should go in, it would be useful to know.

Along the way, it struck me that it would be easiest to explain the different coordinate systems, so I have made a page for that.

I don't know if SVG images can be included, but I have tried that.

Edit: This PR has also grown to include actually including the example scripts and fixing breakages from them.

andreww commented 9 months ago

Do we get previews of updated documentation on read the docs? If not, can we turn this on (apparently there is a 'build pull requests for this project' as an advanced setting on readthedocs)?

I see readthedocs is currently failing its build - since https://github.com/mantle-convection-constrained/terratools/commit/fb8487aa531e67933dc9179b2bfe600ccaef71fa - not sure what's going on.

anowacki commented 9 months ago

It would be nice to have PR docs builds. @bobmyhill are you able to help here? You nicely set all the doc building up for us.

anowacki commented 9 months ago

see readthedocs is currently failing its build - since fb8487a - not sure what's going on.

Hm, that's surprising. Docs building should pass for CI as a whole to pass.

anowacki commented 9 months ago

Docs build failure log here.

It looks a bit like an API change has bitten us upon an upgrade or something.

(Note: to see docs builds, go to the docs page on readthedocs, click on the 'v:latest' button at the bottom right, then 'Builds' in an option to click.)

anowacki commented 9 months ago

Moved issue around docs build failure to #120.

anowacki commented 9 months ago

Docs building on PR moved to #121

anowacki commented 9 months ago

@andreww the build for this PR is at https://terratools--112.org.readthedocs.build/en/112/.