Skip to content

Conversation

trexfeathers
Copy link
Contributor

@trexfeathers trexfeathers commented Jan 14, 2022

Click here for rendered docs

🚀 Pull Request

Description

Closes #4489. Adds a Mesh section to the documentation Further Topics.

To do:

  • Flesh out data_model.rst .
  • Flesh out partner_packages.rst.
  • Flesh out operations.rst

Consult Iris pull request check list

@lbdreyer
Copy link
Member

Looking really great to me so far! The layout seems really easy to follow, and it looks like you are planning on covering all the most important parts, without overwhelming the user with info!
I definitely agree with your plan to use examples as much as possible, I was just wondering about the practicalities of getting this working. In particular, do you have data that can be shared publicly for the examples?

@trexfeathers trexfeathers changed the title UGRID Documentation Mesh Documentation Jan 21, 2022
@trexfeathers
Copy link
Contributor Author

operations.rst is likely to get rather large, given the agreed effectiveness of example code. To compensate for this I would quite like to introduce the Sphinx collapse directive, but I believe it would be the first third party extension we've used so I'm not sure if that's OK.

Any input @tkknight?

@jamesp
Copy link
Member

jamesp commented Jan 21, 2022

It's looking great! 👍

@trexfeathers trexfeathers marked this pull request as ready for review January 27, 2022 17:50
@trexfeathers
Copy link
Contributor Author

I believe I've addressed everyone's comments, either by making a change or by replying. I consider this ready to go.

Copy link
Contributor

@stephenworsley stephenworsley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, just some very small things, but otherwise I think this is looking very close.

@stephenworsley stephenworsley merged commit 224f122 into SciTools:main Jan 28, 2022
@trexfeathers trexfeathers deleted the ugrid_docs branch March 31, 2022 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document UGRID Support
8 participants