Skip to content

Bugfix: Fix the documentation PDF build #2087

@JohnHalleyGotway

Description

@JohnHalleyGotway

Describe the Problem

The METplus documentation builds started failing via Read-The-Docs on 3/14/23. The failures have occurred in the develop, main_v5.0, and feature branches from develop. The failures are due to errors while creating the PDF version. We suspect this problem has existed for some time, but until recently, the PDF problems did not cause the RTD build to be reported as a failure.

Expected Behavior

The PDF generation for the METplus docs should run successfully on both the develop and main_v5.0 branches.

Environment

Fails both via RTD and on my laptop.

To Reproduce

Describe the steps to reproduce the behavior:
1. Setup python on your local machine to support the creation of the docs.
2. Go to the docs directory: cd docs
*3. Render the docs as html and note to good status: make clean html
*4. Render the docs as pdf and note the bad status: make latexpdf | tee latexpdf_docs.log
5. Note the following error messages in the log file:

! LaTeX Error: Unicode character ∫ (U+222B)
! LaTeX Error: Unicode character ω (U+03C9)
! LaTeX Error: Unicode character ζ (U+03B6)
! LaTeX Error: Unicode character 𝑥 (U+1D465)
! LaTeX Error: Unicode character 𝑦 (U+1D466)
! LaTeX Error: Unicode character 𝑥 (U+1D465)
! LaTeX Error: Unicode character 𝑦 (U+1D466)

This task is to find/fix this PDF issues.

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

  • Select Organization level Project for support of the current coordinated release
  • Select Repository level Project for development toward the next official release or add alert: NEED PROJECT ASSIGNMENT label
  • Select Milestone as the next bugfix version

Define Related Issue(s)

Consider the impact to the other METplus components.

Bugfix Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of main_<Version>.
    Branch name: bugfix_<Issue Number>_main_<Version>_<Description>
  • Fix the bug and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • Push local changes to GitHub.
  • Submit a pull request to merge into main_<Version>.
    Pull request: bugfix <Issue Number> main_<Version> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issues
    Select: Organization level software support Project for the current coordinated release
    Select: Milestone as the next bugfix version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Complete the steps above to fix the bug on the develop branch.
    Branch name: bugfix_<Issue Number>_develop_<Description>
    Pull request: bugfix <Issue Number> develop <Description>
    Select: Reviewer(s) and Development issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Close this issue.

Metadata

Metadata

Type

No type

Projects

Status

✅ Done

Relationships

None yet

Development

No branches or pull requests

Issue actions