Skip to content

Updating a few documentation issues#364

Merged
duvivier merged 2 commits into
CICE-Consortium:masterfrom
duvivier:docRTD
Sep 19, 2019
Merged

Updating a few documentation issues#364
duvivier merged 2 commits into
CICE-Consortium:masterfrom
duvivier:docRTD

Conversation

@duvivier
Copy link
Copy Markdown
Contributor

@duvivier duvivier commented Sep 18, 2019

For detailed information about submitting Pull Requests (PRs) to the CICE-Consortium,
please refer to: https://github.com/CICE-Consortium/About-Us/wiki/Resource-Index#information-for-developers

PR checklist

  • Short (1 sentence) summary of your PR:
    Modifying documentation with changes to RTD integration.
  • Developer(s):
    Alice DuVivier
  • Suggest PR reviewers from list in the column to the right.
  • Please copy the PR test results link or provide a summary of testing completed below.
    N/A
  • How much do the PR code changes differ from the unmodified code?
    • bit for bit
    • different at roundoff level
    • more substantial
  • Does this PR create or have dependencies on Icepack or any other models?
    • Yes
    • No
  • Does this PR add any new test cases?
    • Yes
    • No
  • Is the documentation being updated? ("Documentation" includes information on the wiki or in the .rst files from doc/source/, which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/.)
    • Yes
    • No, does the documentation need to be updated at a later time?
      • Yes
      • No
  • Please provide any additional information or relevant details below:
    With the integration of RTD auto builds as part of a PR, we need to update some documentation.
    Most of the documentation will need to be updated on the Wiki instead of code. We shouldn't close this until I've also updated things there:
    https://github.com/CICE-Consortium/About-Us/wiki/Documentation-Workflow-Guidance

I also found that the COREII forcing data should be cited and added that.

Copy link
Copy Markdown
Contributor

@eclare108213 eclare108213 left a comment

Choose a reason for hiding this comment

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

Looks good to me

@duvivier duvivier merged commit 9da39b6 into CICE-Consortium:master Sep 19, 2019
@duvivier duvivier deleted the docRTD branch September 19, 2019 01:42
@duvivier
Copy link
Copy Markdown
Contributor Author

@apcraig @phil-blain
I modified the wiki with instructions on how to use RTD now with the PRs. Please let me know if you want this changed (or change it yourself as necessary):
https://github.com/CICE-Consortium/About-Us/wiki/Documentation-Workflow-Guidance#setting-up-readthedocsorg

@phil-blain
Copy link
Copy Markdown
Member

Looks good Alice @duvivier. I modified the section "Push changes back to the repo" to be more in line with the fact that build happens automatically now.

One minor point : you mention that the user can use different branches for the doc and code modifications ; I think it makes more sense to do both in the same branch, so I think that is what we should recommend in the documentation workflow.

@duvivier
Copy link
Copy Markdown
Contributor Author

@phil-blain Agreed. I just went through and modified that bit as well. I think it's pretty good to go at this point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants