-
Notifications
You must be signed in to change notification settings - Fork 49
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
Add docs and examples for sea ice production tasks #920
Conversation
@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. |
Thanks for the PR, @darincomeau!
If you go into
then you should be able to build the docs on your laptop (or an HPC machine). Then, open:
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. |
You could rebase if you want, since I just merged #919. Then, hopefully you'll see a clean build. |
115ace7
to
fff509b
Compare
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
|
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! |
There was a problem hiding this 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.
@darincomeau, I went ahead and took care of it. It's too minor to bother you with. Thanks again! |
ok great - thanks! |
Adding documentation and examples to #907