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

Create and publish a PDF of the MET User's Guide via Read-The-Docs #1453

Closed
19 tasks
JohnHalleyGotway opened this issue Aug 11, 2020 · 3 comments · Fixed by #1859 or #1871
Closed
19 tasks

Create and publish a PDF of the MET User's Guide via Read-The-Docs #1453

JohnHalleyGotway opened this issue Aug 11, 2020 · 3 comments · Fixed by #1859 or #1871
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: Community General Community type: task An actionable item of work
Milestone

Comments

@JohnHalleyGotway
Copy link
Collaborator

Describe the Task

As of met-9.1, the User's Guide is created via Sphinx and the resulting html output is published to:
https://ncar.github.io/MET/index.html

This task is to render the User's and Contributor's Guides as 2 separate PDF files which would useful for offline viewing. Some users, particularly in secure areas, do not have ready access to the internet for viewing docs on github.io.

George McCabe did some initial investigation but ran into issues rendering equations.

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Define the source of funding and account keys here or state NONE.

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Review projects and select relevant Repository and Organization ones
  • Select milestone

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the task and verify your changes.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop and link the pull request to this issue.
    Pull request: feature <Issue Number> <Description>
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@JohnHalleyGotway JohnHalleyGotway added component: documentation Documentation issue type: task An actionable item of work priority: medium Medium Priority requestor: Community General Community labels Aug 11, 2020
@JohnHalleyGotway JohnHalleyGotway added this to the MET 10.0 milestone Aug 11, 2020
@JohnHalleyGotway JohnHalleyGotway added this to To do in MET-10.0.0-beta1 (10/22/20) via automation Aug 11, 2020
@JohnHalleyGotway JohnHalleyGotway added the alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle label Sep 10, 2020
@JohnHalleyGotway JohnHalleyGotway added this to To do in MET-10.0.0-beta2 (12/7/20) via automation Nov 5, 2020
@JohnHalleyGotway JohnHalleyGotway removed the alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle label Nov 5, 2020
@jprestop jprestop removed this from To do in MET-10.0.0-beta2 (12/7/20) Nov 18, 2020
@jprestop jprestop added this to To do in MET-10.0.0-beta3 (1/27/21) via automation Nov 18, 2020
@JohnHalleyGotway JohnHalleyGotway added this to To do in MET-10.0.0-beta4 (3/2/21) via automation Jan 25, 2021
@JohnHalleyGotway JohnHalleyGotway added this to To do in MET-10.0.0-rc1 (5/10/21) via automation Feb 16, 2021
@JohnHalleyGotway JohnHalleyGotway changed the title Create and publish a PDF of the MET User's Guide for version 10.0. Create and publish a PDF of the MET User's Guide for version 10.0.0. Feb 16, 2021
@JohnHalleyGotway JohnHalleyGotway changed the title Create and publish a PDF of the MET User's Guide for version 10.0.0. Create and publish a PDF of the MET User's Guide. Apr 29, 2021
@JohnHalleyGotway JohnHalleyGotway added this to To do in MET-10.1.0-beta1 (6/13/21) via automation Apr 29, 2021
@TaraJensen TaraJensen added required: FOR OFFICIAL RELEASE Required to be completed in the official release for the assigned milestone and removed required: FOR OFFICIAL RELEASE Required to be completed in the official release for the assigned milestone labels May 17, 2021
@JohnHalleyGotway JohnHalleyGotway added this to To do in MET-10.1.0-beta2 (9/01/21) via automation Jun 11, 2021
@ksearight ksearight moved this from To do to In progress in MET-10.1.0-beta2 (9/01/21) Jun 25, 2021
@ksearight ksearight linked a pull request Jul 20, 2021 that will close this issue
12 tasks
@JohnHalleyGotway
Copy link
Collaborator Author

Coordinated with @ksearight and merged the latest from develop into this feature branch:

Auto-merging met/docs/Users_Guide/wavelet-stat.rst
Auto-merging met/docs/Users_Guide/tc-pairs.rst
Auto-merging met/docs/Users_Guide/index.rst
Auto-merging met/docs/Users_Guide/appendixA.rst

Confirmed that the build succeeded on RTD with no warnings generated.
https://readthedocs.org/projects/met/builds/14295247/

MET-10.1.0-beta2 (9/01/21) automation moved this from In progress to Done Jul 21, 2021
@ksearight
Copy link
Contributor

John HG reported the following on July 22 in Slack:
There's a ROC image that's the last item of section 31.4.13. However in the PDF, it gets served up on page 426, inside of section 31.5.1.I only noticed this when adding new documentation from Eric. Any idea how to FORCE the ROC image to stay where we want it? Maybe a manual page break or something?

@ksearight ksearight reopened this Aug 5, 2021
MET-10.1.0-beta2 (9/01/21) automation moved this from Done to In progress Aug 5, 2021
@ksearight ksearight linked a pull request Aug 5, 2021 that will close this issue
12 tasks
@ksearight
Copy link
Contributor

merged into develop

MET-10.1.0-beta2 (9/01/21) automation moved this from In progress to Done Aug 6, 2021
@TaraJensen TaraJensen added reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project labels Oct 2, 2021
@JohnHalleyGotway JohnHalleyGotway changed the title Create and publish a PDF of the MET User's Guide. Create and publish a PDF of the MET User's Guide via Read-The-Docs Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: Community General Community type: task An actionable item of work
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

5 participants