Skip to content

Mesh Documentation - #4504

Merged
stephenworsley merged 45 commits into
SciTools:mainfrom
trexfeathers:ugrid_docs
Jan 28, 2022
Merged

Mesh Documentation#4504
stephenworsley merged 45 commits into
SciTools:mainfrom
trexfeathers:ugrid_docs

Conversation

@trexfeathers

@trexfeatherstrexfeathers commented Jan 14, 2022

Copy link
Copy Markdown
Contributor

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

Comment threaddocs/src/further_topics/ugrid/operations.rst Outdated
Comment threaddocs/src/whatsnew/latest.rst Outdated
@lbdreyer

Copy link
Copy Markdown
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?

Comment threaddocs/src/further_topics/ugrid/data_model.rst
Comment threaddocs/src/further_topics/ugrid/partner_packages.rst Outdated
@trexfeatherstrexfeathers changed the title UGRID DocumentationMesh DocumentationJan 21, 2022
Comment threaddocs/src/further_topics/ugrid/index.rst Outdated
@trexfeathers

Copy link
Copy Markdown
ContributorAuthor

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?

Comment threaddocs/src/further_topics/ugrid/data_model.rst Outdated
Comment threaddocs/src/further_topics/ugrid/data_model.rst Outdated
Comment threaddocs/src/further_topics/ugrid/data_model.rst Outdated
@jamesp

Copy link
Copy Markdown
Member

It's looking great! 👍

Comment threaddocs/src/further_topics/ugrid/data_model.rst Outdated
@trexfeathers
trexfeathers marked this pull request as ready for review January 27, 2022 17:50
@trexfeathers

Copy link
Copy Markdown
ContributorAuthor

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

Comment threaddocs/src/further_topics/ugrid/operations.rst
Comment threaddocs/src/further_topics/ugrid/data_model.rst
Comment threaddocs/src/further_topics/ugrid/data_model.rst Outdated
Comment threaddocs/src/further_topics/ugrid/operations.rst
Comment threaddocs/src/further_topics/ugrid/operations.rst
Comment threaddocs/src/further_topics/ugrid/operations.rst
Comment threaddocs/src/further_topics/ugrid/operations.rst
Comment threaddocs/src/further_topics/ugrid/operations.rst
Comment threaddocs/src/further_topics/ugrid/operations.rst
Comment threaddocs/src/further_topics/ugrid/operations.rst

@stephenworsleystephenworsley left a comment

Copy link
Copy Markdown
Contributor

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.

Comment threaddocs/src/further_topics/ugrid/data_model.rst Outdated
Comment threaddocs/src/further_topics/ugrid/partner_packages.rst Outdated
@stephenworsley
stephenworsley merged commit 224f122 into SciTools:mainJan 28, 2022
@trexfeathers
trexfeathers deleted the ugrid_docs branch March 31, 2022 13:45
Sign up for freeto 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

@trexfeathers@lbdreyer@jamesp@tkknight@bjlittle@pp-mo@stephenworsley@wjbenfold