Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs and examples for sea ice production tasks #920

Merged
merged 3 commits into from
Oct 11, 2022

Conversation

darincomeau
Copy link
Contributor

Adding documentation and examples to #907

@darincomeau
Copy link
Contributor Author

@xylar I'm not sure how to get the docs to generate off a branch, so I haven't been able to verify/review the output here.

@xylar
Copy link
Collaborator

xylar commented Oct 11, 2022

Thanks for the PR, @darincomeau!

I'm not sure how to get the docs to generate off a branch, so I haven't been able to verify/review the output here.

If you go into docs with your mpas_dev environment and run:

make html

then you should be able to build the docs on your laptop (or an HPC machine). Then, open:

_build/html/index.html

in a browser to see the results. If any red text comes up, we'd want to try to fix it. Some of it may already be fixed in #919, though.

@xylar
Copy link
Collaborator

xylar commented Oct 11, 2022

You could rebase if you want, since I just merged #919. Then, hopefully you'll see a clean build.

@darincomeau
Copy link
Contributor Author

darincomeau commented Oct 11, 2022

Here's the documentation built from this branch on LCRC, so the LCRC header kinda gets in the way, but the new tasks show up:

https://web.lcrc.anl.gov/public/e3sm/diagnostic_output/ac.dcomeau/add-seaice-production-docs/html/

But during the build, I get a huge number of red WARNING: document isn't included in any toctree that seems unrelated? E.g.

...docs/generated/mpas_analysis.shared.timekeeping.utility.date_to_days.rst: WARNING: document isn't included in any toctree

@xylar
Copy link
Collaborator

xylar commented Oct 11, 2022

Perfect! I don't know what the deal is with those "document isn't included" warnings but, no, don't worry about those. This looks great!

Copy link
Collaborator

@xylar xylar left a comment

Choose a reason for hiding this comment

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

Just 4 really pedantic changes that sphinx tends to complain about.

@xylar
Copy link
Collaborator

xylar commented Oct 11, 2022

@darincomeau, I went ahead and took care of it. It's too minor to bother you with. Thanks again!

@darincomeau
Copy link
Contributor Author

ok great - thanks!

@xylar xylar merged commit 944b5b9 into MPAS-Dev:develop Oct 11, 2022
@xylar xylar deleted the add_seaice_production_docs branch October 11, 2022 22:00
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.

None yet

2 participants