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

Readthedocs #187

Merged
merged 8 commits into from
Mar 28, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
[Remove this and add a short summary line]:
Developer(s):
Are the code changes bit for bit, different at roundoff level, or more substantial?
Is the documentation being updated with this PR? (Y/N)
If not, does the documentation need to be updated separately? (Y/N)
"Documentation" includes information on the wiki and .rst files in doc/source/,
which are used to create the online technical docs at https://cice-consortium.github.io/Icepack/
Please suggest code reviewers in the column at right.
Other Relevant Details:

- Developer(s):

- Please suggest code Pull Request reviewers in the column at right.

- Are the code changes bit for bit, different at roundoff level, or more substantial?

- Is the documentation being updated with this PR? (Y/N)
If not, does the documentation need to be updated separately at a later time? (Y/N)
Note: "Documentation" includes information on the wiki and .rst files in doc/source/,
which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-icepack/.

- Other Relevant Details:
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,13 @@ where "branch name" can also be a version name

## Documentation

Detailed and searchable online documentation of Icepack can be found at https://cice-consortium.github.io/Icepack with the following sections:
- [Quick Start](https://cice-consortium.github.io/Icepack/intro/quickstart.html), which has instructions for running the model.
- [Science guide](https://cice-consortium.github.io/Icepack/science_guide/index.html)
- [User guide](https://cice-consortium.github.io/Icepack/user_guide/index.html) with a [Testing](https://cice-consortium.github.io/Icepack/user_guide/ug_testing.html) subsection with instructions for setting up standard tests (e.g. regression, restart).
- [Developer guide](https://cice-consortium.github.io/Icepack/developer_guide/index.html) with a [Documentation](https://cice-consoritum.github.io/Icepack/developer_guide/dg_documentation.html) subsection with instructions on how to update documentation using Sphinx along with code development.
- [Index](https://cice-consortium.github.io/Icepack/icepack_index.html)

**Note that the documentation Table of Contents can be accessed at any point by clicking the upper left hand "Icepack x.x.xx documentation" link.**
Detailed and searchable online documentation of Icepack can be found at https://readthedocs.org/projects/cice-consortium-icepack/ .

This site has the most up-to-date [HTML](http://cice-consortium-icepack.readthedocs.io/en/master/) and [PDF](https://media.readthedocs.org/pdf/cice-consortium-icepack/master/cice-consortium-icepack.pdf) living documentation from the master branch of the CICE-Consortium repository that will be updated regularly with code development.

This site also has static documentation from each Icepack release.

More information about Icepack documentation can be found on the [Icepack Documentation Wiki page](https://github.com/CICE-Consortium/Icepack/wiki/Icepack-Documentation).

## More Information

Expand Down
Binary file removed doc/ACMECollabAgreement_CICE_Hunke_Jul2015.pdf
Binary file not shown.
Binary file removed doc/DocForChanges.pdf
Binary file not shown.
228 changes: 0 additions & 228 deletions doc/DocForChanges.rtf

This file was deleted.

Binary file removed doc/Icepack-v1.0.0.pdf
Binary file not shown.
Loading