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.

Sign up for GitHub

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

Jump to bottom

Add basic framework for a User's Guide using Sphinx documentation. #2

Closed
wants to merge 7 commits into from
Closed

Add basic framework for a User's Guide using Sphinx documentation. #2

wants to merge 7 commits into from

Conversation

JulieSchramm
Copy link
Contributor

Initial commit for a User's Guide.

Julie Schramm added 2 commits October 30, 2019 14:33
Add references.bib
0ddaf7b 
Cite a reference in Chapter 1 to a presentation in references.bib
Add a requirements.txt file to include sphinxcontrib-bibtex
c1750a3
junwang-noaa
junwang-noaa reviewed Oct 31, 2019
View reviewed changes
Copy link

@junwang-noaa junwang-noaa left a comment

Choose a reason for hiding this comment

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

After going through the code, I would suggest to change:

UFS MR Weather App

to
UFS Medium-Range Weather App

in the document for clarity. We use short name ufs-mrweather-app as repository name, but I think we can use full name for documentation.

Address comments in PR #2:
e2a472d 
- Change htmlhelp_basename from CCPPtechnical to UFS-Weather_app
- Change UFS MR Weather App to UFS Medium-Range Weather App
@ligiabernardet
Copy link
Collaborator

Is there anything else needed from the developers in order to accept this PR?

junwang-noaa
junwang-noaa approved these changes Nov 7, 2019
View reviewed changes
Copy link

@junwang-noaa junwang-noaa left a comment

Choose a reason for hiding this comment

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

Code looks good to me.

@JulieSchramm JulieSchramm mentioned this pull request Nov 7, 2019
Merged
@ligiabernardet ligiabernardet mentioned this pull request Dec 19, 2019
Closed
@hertneky hertneky mentioned this pull request Aug 28, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DusanJovic-NOAA DusanJovic-NOAA DusanJovic-NOAA left review comments

@junwang-noaa junwang-noaa junwang-noaa approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@JulieSchramm @ligiabernardet @junwang-noaa @DusanJovic-NOAA